GET v1/Ping?TimeCreatedInGMT={TimeCreatedInGMT}&SecurityHash={SecurityHash}&BrandId={BrandId}
Test whether API is up and your API key is acceptable
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
TimeCreatedInGMT |
Time Created in GMT in seconds since January 1, 1970 |
string |
None. |
SecurityHash |
Security hash for checking purposes |
string |
None. |
BrandId |
Your brand identifier |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
PingResponseName | Description | Type | Additional information |
---|---|---|---|
dateString | string |
None. |
|
success |
indicates the call was successful or not |
boolean |
None. |
errors |
array of error messages |
Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{ "dateString": "sample string 1", "success": true, "errors": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<PingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LandAndFarmWebApi.Response"> <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </errors> <success>true</success> <dateString>sample string 1</dateString> </PingResponse>