Difference between revisions of "API Method PingWithAuth"

From Updox API
Jump to: navigation, search
(Destination Address)
 
(2 intermediate revisions by one user not shown)
Line 3: Line 3:
 
== Fields ==
 
== Fields ==
 
There are no input fields for this method.
 
There are no input fields for this method.
 
== Code Samples ==
 
{| class="wikitable" style="width:900px; vertical-align:top; align:left"
 
! Language || Source Code Examples
 
|-
 
| width="50px"| C# || <div class="mw-collapsible mw-collapsed" style="width:65px">
 
<div class="mw-collapsible-content" style="width:810px">
 
</div>
 
|-
 
| align="top" | Java || <div class="mw-collapsible mw-collapsed" style="width:65px">
 
<div class="mw-collapsible-content" style="width:810px">
 
 
 
{{Json API HMAC Block- Java}}
 
 
 
|}
 
 
== Messages ==
 
=== Destination Address ===
 
<div style="width:500px;">
 
  {{Base url api|pingWithAuth|pingWithAuth}}
 
</div>
 
  
 
== Sample Request and Response ==
 
== Sample Request and Response ==

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.

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.