Difference between revisions of "API Method PingWithAuth"

Latest revision as of 17:05, 27 November 2013

Ping the server for a response with full authentication. This method verifies that applicationId and applicationPassword are valid and that there is a valid userId under a valid accountId.

Fields

There are no input fields for this method.

Sample Request and Response

Request

{
    "auth": {
        "applicationId": "updox",
        "applicationPassword": "1234567890",
        "accountId": "account",
        "userId": "user"
    }
}

Response

{
    "successful": true,
    "responseMessage": "OK",
    "responseCode": 2000
}

Error Codes

This API method will only return the General Error Set.