[[PageOutline(3-4, Sections)]]

== !CheckMovieHash == 


=== Intro ===

  check if video file hashes are already stored in the database


----
=== Description ===

  '''struct !CheckMovieHash(string $token, array($moviehash, $moviehash, ...) $hashes)'''
  
  Checks if given video file hashes ''hashes'' are already stored in the database.
  
  If found, the server will return basic movie information, including IMDb ID, movie title, release year.
  
  This information can be then used in client application to automatically fill (or verify) movie info.


----
=== Parameters ===

  ''token (required)''::
    token string identifying user's session, taken from [wiki:XmlRpcLogIn LogIn] output structure.
  ''hashes (required)''::
    array/list of [wiki:HashSourceCodes video file hashes]


----
=== Return Values ===

  Output is returned in this structure: 
{{{
  struct(
    struct( <-- list of movie info structures
      struct( <-- movie information structure (movieinfo)
        (string) [MovieHash],
        (string) [MovieImdbID],
        (string) [MovieName],
        (string) [MovieYear]
      ) [<video file hash>],
      struct( movieinfo ) [<video file hash>],
      
      ... more movie information structures go here (if any) ...
      
    ) [data],
    (double) [seconds]
  )
}}}

  and contains these elements:

  The returned structure contains these elements:
    ''status''::
      function result code, see [wiki:XmlRpcStatusCode list of status codes]
    ''data''::
      list of movie info structures ''movieinfo''
    ''movieinfo''::
      information about a movie containing:
        * ''!MovieHash'': video file hash, you can use this value to match the movie info to your input parameters
        * ''MovieImdbID'': movie IMDb ID
        * ''!MovieName'': movie title
        * ''!MovieYear'': movie release year
    ''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>CheckMovieHash</methodName>
 <params>
  <param>
   <value><string>gqb4qjfkc66vb0sarm8j60o3t7</string></value>
  </param>
  <param>
   <value>
    <array>
     <data>
      <value><string>d7aa0275cace4410</string></value>
      <value><string>ca8f3c95403dd70f</string></value>
      
      ... more video file hashes go here (if any) ...
      
     </data>
    </array>
   </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>d7aa0275cace4410</name>
         <value>
          <struct>
           <member>
            <name>MovieHash</name>
            <value><string>d7aa0275cace4410</string></value>
           </member>
           <member>
            <name>MovieImdbID</name>
            <value><string>371746</string></value>
           </member>
           <member>
            <name>MovieName</name>
            <value><string>Iron Man</string></value>
           </member>
           <member>
            <name>MovieYear</name>
            <value><string>2008</string></value>
           </member>
          </struct>
          
          ... more movie information structures go here (if any) ...
          
         </value>
        </member>
       </struct>
      </value>
     </member>
     <member>
      <name>seconds</name>
      <value><double>3.525</double></value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodResponse>
}}}


----
=== Notes ===

  none yet


----
=== See also ===


----
=== Comments ===

	add your comments, hints and suggestions here if you like ...


--------
[Prev] [wiki:XmlRpcIntro Home] [Next]