Difference between revisions of "API Method PingWithApplicationAuth"

From Updox API
Jump to: navigation, search
(Init)
 
m (Adds fields)
Line 1: Line 1:
 
Ping the server for a response with application level authentication. This method verifies that only the <code>applicationId</code> and <code>applicationPassword</code> are valid.  
 
Ping the server for a response with application level authentication. This method verifies that only the <code>applicationId</code> and <code>applicationPassword</code> are valid.  
 +
 
 +
== Fields ==
 +
There are no input fields for this method. 
 
    
 
    
 
== Sample Request and Response ==
 
== Sample Request and Response ==

Revision as of 12:12, 11 November 2013

Ping the server for a response with application level authentication. This method verifies that only the applicationId and applicationPassword are valid.

Contents

Fields

There are no input fields for this method.

Sample Request and Response

Request

{
    "auth": {
        "applicationId": "updox",
        "applicationPassword": "1234567890"
    }
}

Response

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

Error Codes

This API method will only return the General Error Set.