Remiandre: /* countTus */

2024-01-17T09:02:08Z

‎countTus

Remiandre at 14:37, 20 March 2015

2015-03-20T14:37:45Z

New page

[[Wordfast Anywhere TMs and glossaries API#cmds|Return to command list]]

= countTus =
'''countTus''' (string '''key''', int '''cmd''')

Count the number of Translation Units of all the TMs.

=== Parameters ===
{|class="wikitable" style="text-align: left;"
|'''key'''
|string
|a valid API Key, generated by making a share at www.freetm.com
|-
|'''cmd'''
|int
|command number is 501
|}

=== Returned value ===
{|class="wikitable" style="text-align: left;"
|connections
|array
|Detail of TUs count for each connection
{|class="wikitable" style="text-align: left;"
|'''id'''
|int
|connection ID
|-
|'''tms'''
|array
|TUs counts
{|class="wikitable" style="text-align: left;"
|'''tmid'''
|int
|TM ID
|-
|'''privateCount'''
|int
|private TU count
|-
|'''publicCount'''
|int
|public TU count
|-
|'''count'''
|int
|sum of private and public count
|}
|-
|'''error'''
|string
|error messages
|}
|}

=== Request example ===
==== json post with javascript ====
var data = {};
data["key"] = "example@key";
data["cmd"] = 501;
var xhr = new XMLHttpRequest();
xhr.open("POST", "www.freetm.com/wfa/api", true);
xhr.setRequestHeader("Content-Type", "application/json;charset=UTF-8");
xhr.send(JSON.stringify(data));

==== post ====
<form action="www.freetm.com/wfa/api" method="post">
<input type="text" id="key" name="key" value="example@key"/>
<input type="text" id="cmd" name="cmd" value="501"/>
<input type="submit" value="Submit">
</form>

==== get ====
www.freetm.com/wfa/api?key=example@key&cmd=501

=== Response example ===
==== json ====
{

"connections": [{
"id": 1
,"tms": [{
"tmid":1, "privateCount":0, "publicCount":0, "count":0
}
,{...}
]
,"error": ""
}
,{...}
]
}
without white space (new line, carriage return or tabulation).

==== text ====
id:1 '''LF'''
tmid:1 '''tab''' privateCount:0 '''tab''' publicCount:0 '''tab''' count:0 '''LF'''
error: '''LF'''

'''LF''' is a Line feed (new line \u000A)<br>
'''tab''' is a tabulation (\u0009)

=== Remarks ===
Timeout is 10 seconds

@@ Line 60: / Line 60: @@
   data["cmd"] = 501;
   var xhr = new XMLHttpRequest();
-  xhr.open("POST", "www.freetm.com/wfa/api", true);
+  xhr.open("POST", "anywhere.wordfast.com/wfa/api", true);
   xhr.setRequestHeader("Content-Type", "application/json;charset=UTF-8");
   xhr.send(JSON.stringify(data));
 ==== post ====
-  <form action="www.freetm.com/wfa/api" method="post">
+  <form action="anywhere.wordfast.com/wfa/api" method="post">
      <input type="text" id="key" name="key" value="example@key"/>
      <input type="text" id="cmd" name="cmd" value="501"/>
@@ Line 72: / Line 72: @@
 ==== get ====
-  www.freetm.com/wfa/api?key=example@key&cmd=501
+  anywhere.wordfast.com/wfa/api?key=example@key&cmd=501
 === Response example ===

CountTus - Revision history

Remiandre: /* countTus */

Remiandre at 14:37, 20 March 2015