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

== !ServerInfo == 

=== Intro ===

  get some basic server information


----
=== Description ===

  '''struct !ServerInfo()'''
  
  This function returns a structure with basic server information (urls, contacts) and some statistics, including number of users currently online.


----
=== Parameters ===

  this function has no parameters


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

  Output is returned in this structure:
{{{
struct(
  (string) [xmlrpc_version],
  (string) [xmlrpc_url],
  (string) [application],
  (string) [contact],
  (string) [website_url],
  (string) [users_online_total],
  (string) [users_online_program],
  (string) [users_loggedin],
  (string) [users_max_alltime],
  (string) [users_registered],
  (string) [subs_downloads],
  (string) [subs_subtitle_files],
  (string) [movies_total],
  (string) [movies_aka],
  (string) [total_subtitles_languages],
  struct(
    (string) [<language ISO639 2-letter code>],
    ... more languages go here ...
  ) [last_update_strings],
  (double) [seconds]
)
}}}

  and contains these elements:
    ''xmlrpc_version''::
      version of server's XML-RPC API implementation
    ''xmlrpc_url''::
      XML-RPC interface URL
    ''application''::
      server's application name and version
    ''contact''::
      contact e-mail address for server related quuestions and problems
    ''website_url''::
      main server URL
    ''users_online_total''::
      number of users currently online
    ''users_online_program''::
      number of users currently online using a client application (XML-RPC API)
    ''users_loggedin''::
      number of currently logged-in users
    ''users_max_alltime''::
      maximum number of users throughout the history
    ''users_registered''::
      number of registered users
    ''subs_downloads''::
      total number of subtitle downloads
    ''subs_subtitle_files''::
      total number of subtitle files stored on the server
    ''movies_total''::
      total number of movies in the database
    ''movies_aka''::
      total number of movie A.K.A. titles in the database
    ''total_subtitles_languages''::
      total number of subtitle languages supported
    ''last_update_strings''::
      structure containing information about last updates of translations
    ''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>ServerInfo</methodName>
 <params>
 </params>
</methodCall>
}}}

  
==== Output ====

{{{
#!xml
<methodResponse>
 <params>
  <param>
   <value>
    <struct>
     <member>
      <name>xmlrpc_version</name>
      <value><string>0.1</string></value>
     </member>
     <member>
      <name>xmlrpc_url</name>
      <value><string>http://www.opensubtitles.org/xml-rpc</string></value>
     </member>
     <member>
      <name>application</name>
      <value><string>OpenSuber v0.2</string></value>
     </member>
     <member>
      <name>contact</name>
      <value><string>... admin's e-mail address goes here ...</string></value>
     </member>
     <member>
      <name>website_url</name>
      <value><string>http://www.opensubtitles.org</string></value>
     </member>
     <member>
      <name>users_online_total</name>
      <value><string>2024</string></value>
     </member>
     <member>
      <name>users_online_program</name>
      <value><string>732</string></value>
     </member>
     <member>
      <name>users_loggedin</name>
      <value><string>48</string></value>
     </member>
     <member>
      <name>users_max_alltime</name>
      <value><string>9465</string></value>
     </member>
     <member>
      <name>users_registered</name>
      <value><string>525040</string></value>
     </member>
     <member>
      <name>subs_downloads</name>
      <value><string>94110800</string></value>
     </member>
     <member>
      <name>subs_subtitle_files</name>
      <value><string>642475</string></value>
     </member>
     <member>
      <name>movies_total</name>
      <value><string>39502</string></value>
     </member>
     <member>
      <name>movies_aka</name>
      <value><string>59974</string></value>
     </member>
     <member>
      <name>total_subtitles_languages</name>
      <value><string>50</string></value>
     </member>
     <member>
      <name>last_update_strings</name>
      <value>
       <struct>
         <name>en</name>
         <value><string>2007-02-03 21:36:14</string></value>
        </member>
        
        ... more languages ...
        
       </struct>
      </value>
     </member>
     <member>
      <name>seconds</name>
      <value><double>0.006</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]