POST api/vending/ping

Ping

Request Information

URI Parameters

None.

Body Parameters

Ping request params

Name	Description	Type	Additional information
ServiceMode	Device Service Mode Info	boolean	None.
SignalStrength	Device Signal Strength in dBm	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ServiceMode": true,
  "SignalStrength": 2
}

application/xml, text/xml

Sample:

<PingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vending.API.Classes">
  <ServiceMode>true</ServiceMode>
  <SignalStrength>2</SignalStrength>
</PingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Info about blocking device and firmware and Service Mode request

PingResponse

Name	Description	Type	Additional information
Blocked	Device Blocked Request	boolean	None.
Firmware	Device Requested Firware Version	string	None.
ServiceMode	Device Service Mode Request	EnumServiceModeRequest	None.
DataReload	Device Data Reload Request	boolean	None.
BlockedPositions	List of blocked positions	Collection of integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Blocked": true,
  "Firmware": "sample string 2",
  "ServiceMode": 0,
  "DataReload": true,
  "BlockedPositions": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<PingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vending.API.Classes">
  <Blocked>true</Blocked>
  <BlockedPositions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BlockedPositions>
  <DataReload>true</DataReload>
  <Firmware>sample string 2</Firmware>
  <ServiceMode>None</ServiceMode>
</PingResponse>