Changes between Version 6 and Version 7 of XmlRpcIntro

Timestamp:

Oct 12, 2008, 5:03:59 PM (16 years ago)

Author:

majky

Comment:

Updated 'Movies' section

XmlRpcIntro

@@ -62 +62 @@
 = XML-RPC methods =
 
+  Every method returns a XML-RPC ''struct'' data type.
+  
+  In OpenSubtitles.org most XML-RPC API server-side implementation most single-type variables in method output are of type ''string'' (even though you might expect ''int'' so beware)  
+  
+
+----
 == Session handling ==
   * [wiki:XmlRpcLogIn LogIn] - login user and start session
@@ -71 +77 @@
 
 
+----
 == Search and download ==
   * [wiki:XmlRpcSearchSubtitles SearchSubtitles] - search for subtitles using video hashes or IMDb ID
@@ -80 +87 @@
 
 
+----
 == Upload ==
   * [wiki:XmlRpcTryUploadSubtitles TryUploadSubtitles] - check subtitles before uploading
@@ -87 +95 @@
 
 
+----
 == Movies ==
-  * [wiki:XmlRpcSearchMoviesOnIMDB SearchMoviesOnIMDB] -
-  * [wiki:XmlRpcGetIMDBMovieDetails GetIMDBMovieDetails] - get movie details fro given IMDb ID
+  * [wiki:XmlRpcSearchMoviesOnIMDB SearchMoviesOnIMDB] - search for a movie (using movie title)
+      '''struct SearchMoviesOnIMDB(string $token, string $query)'''
+  * [wiki:XmlRpcGetIMDBMovieDetails GetIMDBMovieDetails] - get movie details for given IMDb ID
+      '''struct GetIMDBMovieDetails(string $token, string $imdbid)'''
   * [wiki:XmlRpcInsertMovie InsertMovie] - insert a new movie
+      '''struct !InsertMovie(string $token, struct('moviename' => string $moviename, 'movieyear' => string $movieyear) $movieinfo)'''
 
 
+----
 == Reporting and rating ==
   * [wiki:XmlRpcServerInfo ServerInfo] - get basic server information and statistics
@@ -101 +114 @@
 
 
+----
 == User interface ==
   * [wiki:XmlRpcGetSubLanguages GetSubLanguages] - get supported subtitle languages
       '''struct !GetSubLanguages(string $language = 'en')'''
   * [wiki:XmlRpcDetectLanguage DetectLanguage] - detect language for given text
+      '''struct !DetectLanguage(string $token, array($text, $text, ...) $data)'''
   * [wiki:XmlRpcGetAvailableTranslations GetAvailableTranslations] - get list of available translations for a client application
       '''struct !GetAvailableTranslations(string $token, string $program)'''
@@ -113 +128 @@
 
 
+----
 == Checking ==
   * [wiki:XmlRpcCheckMovieHash CheckMovieHash] - check if video files are already stored in the database
@@ -120 +136 @@
 
 
+----
 = Credits =
-  * 2ge - writer of OSDb XML-RPC server-side implementation
+  * 2ge - developer of OSDb XML-RPC server-side implementation
   * eduo - supplier of various example inputs/outputs
   * all other contributors