Difference between revisions of "API Method Ping"

From Updox API
Jump to: navigation, search
(Init)
 
m (Adds fields.)
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
 
Ping the server for a response without any authentication.   
 
Ping the server for a response without any authentication.   
 
    
 
    
 +
== Fields ==
 +
There are no input fields for this method.
 +
 
== Sample Request and Response ==
 
== Sample Request and Response ==
  
 
==== Request ====
 
==== Request ====
  {
+
  {}
    "auth": {
+
        "applicationId": "updox",
+
        "applicationPassword": "1234567890",
+
        "accountId": "account",
+
        "userId": "user"
+
    }
+
}
+
  
 
==== Response ====
 
==== Response ====

Latest revision as of 12:11, 11 November 2013

Ping the server for a response without any authentication.

Contents

Fields

There are no input fields for this method.

Sample Request and Response

Request

{}

Response

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

Error Codes

This API method will only return the General Error Set.