getUserData

This methods return data for logged user.

Authentication

This method requires authentication.

Arguments

Argument Type Valid Values Default Value Detail
api_key string Valid Values required you need a valid api key to use the API
session_id string existing session ID required authentified session ID( use loginUser to create a session ID)

Returned Values

Element (path) Name Type Description
/ id int user unique ID
/ language_id int user language ID
/ language_name string user language name
/ nb_credits int user total credit number
/ credit_value float user credit value
/ currency_name int user credit currency name
/ currency_symbol int user credit currency symbol

Example Query


<?xml version="1.0" encoding="utf-8"?>
<methodCall>
	<methodName>xmlrpc.getUserData</methodName>
	<params>
		<param>
			<value>
				<string>YOUR_API_KEY</string>
			</value>
		</param>
		<param>
			<value>
				<string>SESSION_ID</string>
			</value>
		</param>
	</params>
</methodCall>

Example Response


<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>id</name>
            <value>
              <int>1</int>
            </value>
          </member>
          <member>
            <name>language_id</name>
            <value>
              <int>3</int>
            </value>
          </member>
          <member>
            <name>language_name</name>
            <value>
              <string>English</string>
            </value>
          </member>
          <member>
            <name>nb_credits</name>
            <value>
              <int>0</int>
            </value>
          </member>
          <member>
            <name>credit_value</name>
            <value>
              <string>0.68</string>
            </value>
          </member>
          <member>
            <name>currency_name</name>
            <value>
              <string>Pound</string>
            </value>
          </member>
          <member>
            <name>currency_symbol</name>
            <value>
              <string>£</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

Error Codes

001: Service currently unavailable
The requested service is temporarily unavailable.
002: Failed to parse request
The XML-RPC request document could not be parsed.
010: Missing API Key
The API key passed is missing.
011: Invalid API Key
The API key passed is not valid or has expired.
020: Missing Session ID
The session ID passed is missing. A valid session ID is needed to access this method
021: Invalid Session ID
The session ID passed is not valid. Please login to get a valid session ID.
031: Invalid Method
This method does not exist in the method list.
032: Method not Available
This method is not available for this API Key.