Changes between Version 102 and Version 103 of XMLRPC

Timestamp:

May 31, 2016, 6:01:19 AM (8 years ago)

Author:

os

Comment:

--

XMLRPC

@@ -956 +956 @@
 All field are self-explained.
 
+----
+
+== !QuickSuggest ==
+'''array !QuickSuggest( $token, $string, $sublanguageid )'''
+
+This method is useful, when user is typing movie name in search subtitles area. Use-case scenario - user is in search subtitles pane of program, and searching for subtitles. He start typing, and this method returns count of existing subtitles for given languages, then he select some movie, and !SearchSubtitles by IDMovieIMDB is performed. $sublanguageid can be more languages "eng,por,pob" for example. The results are ordered by popularity of movie, the !SubtitlesFound is always higher than 0. This method is not suitable to implement in Upload area of program (because only existing IMDBIDs are returned which got suitable subtitles). $sublanguageid is optional, if not specified ($sublanguage == 'all'), then for all languages is suggestion made, so it is good idea to pass user-defined subtitle language(s) here. 
+
+We are using exactly same logic and data on website, the URL for JSON output is http://www.opensubtitles.org/libs/suggest.php?format=json3&MovieName=m&SubLanguageID=eng,por,pob - but if possible use xml-rpc method.
+
+Example output for $string = 'm':
+{{{
+Array
+(
+    [status] => 200 OK
+    [data] => Array
+        (
+            [0] => Array
+                (
+                    [SubtitlesFound] => 70
+                    [MovieName] => Martian
+                    [MovieYear] => 2015
+                    [IDMovieIMDB] => 3659388
+                    [MovieKind] => movie
+                    [MovieImdbRating] => 8.1
+                )
+
+            [1] => Array
+                (
+                    [SubtitlesFound] => 2133
+                    [MovieName] => Modern Family
+                    [MovieYear] => 2009
+                    [IDMovieIMDB] => 1442437
+                    [MovieKind] => tv
+                    [MovieImdbRating] => 8.6
+                )
+
+            [2] => Array
+                (
+                    [SubtitlesFound] => 51
+                    [MovieName] => Minions
+                    [MovieYear] => 2015
+                    [IDMovieIMDB] => 2293640
+                    [MovieKind] => movie
+                    [MovieImdbRating] => 6.5
+                )
+
+            [3] => Array
+                (
+                    [SubtitlesFound] => 60
+                    [MovieName] => Mission: Impossible - Rogue
+                    [MovieYear] => 2015
+                    [IDMovieIMDB] => 2381249
+                    [MovieKind] => movie
+                    [MovieImdbRating] => 7.5
+                )
+
+            [4] => Array
+                (
+                    [SubtitlesFound] => 8
+                    [MovieName] => Mr. Right
+                    [MovieYear] => 2015
+                    [IDMovieIMDB] => 2091935
+                    [MovieKind] => movie
+                    [MovieImdbRating] => 6.3
+                )
+
+        )
+
+    [seconds] => 0.002
+)
+}}}
+
+'''Fields explanation:'''
+All field are self-explained.
 
 ----