test

This method is a test method which returns success if connexion is valid.

Authentication

This method does requires authentification.

Arguments

Argument Type Valid Values Default Value Detail
api_key string Valid Values required you need a valid api key to use the API

Returned Values

Element (path) Name Type Description
/ test string returns SUCCESS

Example Query


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

Example Response


<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>test</name>
            <value>
              <string>SUCCESS</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.
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.