Difference between revisions of "API Method PingWithAuth"
From Updox API
(Init) |
m (Adds fields) |
||
| Line 1: | Line 1: | ||
Ping the server for a response with full authentication. This method verifies that <code>applicationId</code> and <code>applicationPassword</code> are valid and that there is a valid <code>userId</code> under a valid <code>accountId</code>. | Ping the server for a response with full authentication. This method verifies that <code>applicationId</code> and <code>applicationPassword</code> are valid and that there is a valid <code>userId</code> under a valid <code>accountId</code>. | ||
| + | == Fields == | ||
| + | There are no input fields for this method. | ||
| + | |||
== Sample Request and Response == | == Sample Request and Response == | ||
Revision as of 12:11, 11 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.
Contents |
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.
