Changes between Initial Version and Version 1 of XmlRpcGetAvailableTranslations

Timestamp:

Sep 28, 2008, 12:03:13 PM (16 years ago)

Author:

guest

Comment:

Created this page [Majky]

XmlRpcGetAvailableTranslations

@@ +1 @@
+
+[[PageOutline(3-4, Sections)]]
+
+== !GetAvailableTranslations ==
+
+=== Intro ===
+
+  get available translations for given program
+
+
+----
+=== Description ===
+
+  '''struct !GetAvailableTranslations(string $token, string $program)'''
+  
+  Returns a structure containing all available translations for a program ''program''.
+  
+  Currently supported programs are ''subdownloader'' and ''oscar''.
+  
+
+----
+=== Parameters ===
+
+  ''token (required)''::
+    token string identifying user's session, taken from [wiki:XmlRpcLogIn LogIn] output structure.
+  ''program''::
+      * name of the program/client application you want translations for.
+      * currently supported values: ''subdownloader'', ''oscar''
+
+
+----
+=== Return Values ===
+
+  Output is returned in this structure:
+
+{{{
+struct(
+  (string) [status],
+  struct(
+    struct(
+      (string) [LastCreated],
+      (string) [StringsNo]
+    ) [<language ISO639 2-letter code>],
+    struct(
+    ), ... more languages go here ...
+  ) [data],
+  (string) [seconds]
+)
+}}}
+
+  and contains these elements:
+    ''status''::
+      function result code, see [wiki:XmlRpcStatusCode list of status codes]
+    ''data''::
+      structure of subtitle languages containing:
+        * ''!LastCreated'': last date/time a translation was created/modified in this language
+        * ''!StringsNo'': number of translated strings currently available in this translation         
+    ''seconds''::
+      time taken to execute this command on server
+
+
+----
+=== Implementations ===
+
+  There are currently no available sample implementations.
+
+
+----
+=== Changelog ===
+
+  Version 1: created this function
+
+
+----
+=== Examples ===
+
+
+==== Input ====
+  
+{{{
+#!xml
+<methodCall>
+ <methodName>GetAvailableTranslations</methodName>
+ <params>
+  <param>
+   <value>
+    <string>d5pnounn3ea5aja0nn4inqamf2</string>
+   </value>
+  </param>
+  <param>
+   <value><string>oscar</string></value>
+  </param>
+ </params>
+</methodCall>
+}}}
+
+  
+==== Output ====
+
+{{{
+#!xml
+<methodResponse>
+ <params>
+  <param>
+   <value>
+    <struct>
+     <member>
+      <name>status</name>
+      <value>
+       <string>200 OK</string>
+      </value>
+     </member>
+     <member>
+      <name>data</name>
+      <value>
+       <struct>
+        <member>
+         <name>en</name>
+         <value>
+          <struct>
+           <member>
+            <name>LastCreated</name>
+            <value><string>2007-10-19 12:44:00</string></value>
+           </member>
+           <member>
+            <name>StringsNo</name>
+            <value><string>266</string></value>
+           </member>
+          </struct>
+         </value>
+        </member>
+        
+        ...  more languages go here ...
+
+       </struct>
+      </value>
+     </member>
+     <member>
+      <name>seconds</name>
+      <value><double>0.006</double></value>
+     </member>
+    </struct>
+   </value>
+  </param>
+ </params>
+</methodResponse>
+}}}
+
+
+----
+=== Notes ===
+
+  none yet
+
+
+----
+=== See also ===
+
+  * [wiki:XmlRpcGetTranslation GetTranslation]
+
+
+----
+=== Comments ===
+
+        add your comments, hints and suggestions here if you like ...
+
+
+--------
+[Prev] [wiki:XmlRpcIntro Home] [wiki:XmlRpcGetTranslation Next (GetTranslation)]