Changes between Initial Version and Version 1 of XmlRpcReportWrongMovieHash


Ignore:
Timestamp:
Oct 28, 2009, 9:34:41 AM (14 years ago)
Author:
guest
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • XmlRpcReportWrongMovieHash

    v1 v1  
     1[[PageOutline(3-4, Sections)]]
     2
     3== !ReportWrongMovieHash ==
     4
     5=== Intro ===
     6
     7  report wrong subtitle file <--> video file combination
     8
     9
     10----
     11=== Description ===
     12
     13  '''struct !ReportWrongMovieHash(string $token, string $IDSubMovieFile)'''
     14
     15  This method is used to report subtitle file <--> video file combination,
     16  i.e. subtitle contents are correct but but they are not synchronized to match this video file.
     17 
     18  With this method number of reports is counted in database and after a certain number of reports is reached,
     19  hash is automatically deleted from the database.
     20
     21
     22----
     23=== Parameters ===
     24
     25{{{
     26struct(
     27  (string) [token],
     28  (string) [IDSubMovieFile]
     29)
     30}}}
     31
     32  ''token (required)''::
     33    token string identifying user's session, taken from [wiki:XmlRpcLogIn LogIn] output structure.
     34  ''IDSubMovieFile (required)''::
     35    identifier of the subtitle file <--> video file combination
     36
     37----
     38=== Return Values ===
     39
     40  Output is returned in this structure:
     41{{{
     42struct(
     43  (string) [status],
     44  (double) [seconds]
     45)
     46}}}
     47
     48  and contains these elements:
     49    ''status''::
     50      function result code, see [wiki:XmlRpcStatusCode list of status codes]
     51    ''seconds''::
     52      time taken to execute this command on server
     53
     54
     55----
     56=== Implementations ===
     57
     58  There are currently no available sample implementations.
     59
     60
     61----
     62=== Changelog ===
     63
     64  Version 1: created this function
     65
     66
     67----
     68=== Examples ===
     69
     70
     71==== Input ====
     72 
     73{{{
     74#!xml
     75<methodCall>
     76 <methodName>ReportWrongMovieHash</methodName>
     77 <params>
     78  <param>
     79   <value><string>a41j170ljs0jd6s375t0hp9mf6</string></value>
     80  </param>
     81  <param>
     82   <value><int>39620</int></value>
     83  </param>
     84 </params>
     85</methodCall>
     86}}}
     87
     88 
     89==== Output ====
     90
     91{{{
     92#!xml
     93<methodResponse>
     94 <params>
     95  <param>
     96   <value>
     97    <struct>
     98     <member>
     99      <name>status</name>
     100      <value><string>200 OK</string></value>
     101     </member>
     102     <member>
     103      <name>seconds</name>
     104      <value><double>0.703</double></value>
     105     </member>
     106    </struct>
     107   </value>
     108  </param>
     109 </params>
     110</methodResponse>
     111}}}
     112
     113
     114----
     115=== Notes ===
     116
     117  none yet
     118
     119
     120----
     121=== See also ===
     122
     123
     124----
     125=== Comments ===
     126
     127        add your comments, hints and suggestions here if you like ...
     128
     129
     130--------
     131[Prev] [wiki:XmlRpcIntro Home] [Next]