Changes between Initial Version and Version 1 of XmlRpcLogIn


Ignore:
Timestamp:
Sep 25, 2008, 6:27:08 PM (16 years ago)
Author:
guest
Comment:

Created this page [Majky]

Legend:

Unmodified
Added
Removed
Modified

  • XmlRpcLogIn

    v1 v1  
     1
     2== !LogIn ==
     3
     4[[PageOutline(3, Sections)]]
     5
     6=== Intro ===
     7
     8  login given user, set interface language and initiate session
     9
     10
     11=== Description ===
     12
     13  '''struct !LogIn(string $username, string $password, string $language, string $useragent)'''
     14
     15  Login user ''username'' identified by password ''password'' communicating in language ''language'' and working in client application ''useragent''.
     16   
     17  This function should be always called when starting communication with OSDb server to identify user, specify application and start a new session (either registered user or anonymous).
     18 
     19  If user has no account, blank username and password should be used.
     20
     21
     22=== Parameters ===
     23
     24        ''username''::
     25          nickname of user that's trying to login,
     26          can be left blank if logging in anonymously
     27        ''password''::
     28          user's password to verify identity,
     29          can be left blank if logging in anonymously
     30        ''language''::
     31          [http://en.wikipedia.org/wiki/List_of_ISO_639-2_codes ISO639] 2-letter language code to specify the language all subsequent communication should use (mainly for error messages).
     32        ''useragent (required)''::
     33          identifier of application/useragent that is trying to execute this operation,
     34          must be specified, empty parameter is not allowed
     35
     36
     37=== Return Values ===
     38
     39The returned structure contains these elements:
     40   ''token''::
     41     token string/session id, must be used in subsequent communication
     42   ''status''::
     43     function result code, see [wiki:XmlRpcStatusCode list of status codes]
     44   ''seconds''::
     45     time taken to execute this command on server
     46
     47
     48=== Implementations ===
     49
     50  [wiki:XmlRpcLogInImpl#delphi Delphi]
     51
     52
     53=== Changelog ===
     54
     55        Version 1: created this function
     56
     57
     58=== Examples ===
     59
     60
     61==== Input ====
     62
     63{{{
     64#!xml
     65<methodCall>
     66 <methodName>LogIn</methodName>
     67 <params>
     68  <param>
     69   <value>
     70    <string>eduo</string>
     71   </value>
     72  </param>
     73  <param>
     74   <value>
     75    <string>******</string>
     76   </value>
     77  </param>
     78  <param>
     79   <value>
     80    <string>en</string>
     81   </value>
     82  </param>
     83  <param>
     84   <value>
     85    <string>SolEol 0.0.8</string>
     86   </value>
     87  </param>
     88 </params>
     89</methodCall>
     90}}}
     91 
     92==== Output ====
     93
     94{{{
     95#!xml
     96<methodResponse>
     97<params>
     98 <param>
     99  <value>
     100   <struct>
     101    <member>
     102     <name>token</name>
     103     <value>
     104      <string>j5dkms7al7vivnrvaflbpf6634</string>
     105     </value>
     106    </member>
     107    <member>
     108     <name>status</name>
     109     <value>
     110      <string>200 OK</string>
     111     </value>
     112    </member>
     113    <member>
     114     <name>seconds</name>
     115     <value>
     116      <double>0.035</double>
     117     </value>
     118    </member>
     119   </struct>
     120  </value>
     121 </param>
     122</params>
     123</methodResponse>
     124}}}
     125
     126
     127
     128=== Notes ===
     129
     130        none yet
     131
     132
     133=== See also ===
     134
     135  * [wiki:XmlRpcLogOut LogOut]
     136  * [wiki:XmlRpcNoOperation NoOperation]
     137
     138
     139=== Comments ===
     140
     141        add your comments, hints and suggestion here if you like ...
     142
     143
     144
     145[Prev] [wiki:XmlRpcIntro Home] [wiki:XmlRpcLogOut Next]