POST v1/Ping

Test whether post settings are working correctly or not

Request Information

URI Parameters

None.

Body Parameters

PingRequest
NameDescriptionTypeAdditional 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.

Request Formats

application/json, text/json

Sample:
{
  "timeCreatedInGMT": "sample string 1",
  "securityHash": "sample string 2",
  "brandId": 3
}

application/xml, text/xml

Sample:
<PingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LandAndFarmWebApi.Models">
  <brandId xmlns="http://schemas.datacontract.org/2004/07/LandAndFarmWebApi.Request">3</brandId>
  <securityHash xmlns="http://schemas.datacontract.org/2004/07/LandAndFarmWebApi.Request">sample string 2</securityHash>
  <timeCreatedInGMT xmlns="http://schemas.datacontract.org/2004/07/LandAndFarmWebApi.Request">sample string 1</timeCreatedInGMT>
</PingRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PingRequest'.

Response Information

Resource Description

PingResponse
NameDescriptionTypeAdditional 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>