POST RTVPRetailerPing

Request Information

URI Parameters

None.

Body Parameters

RetailerPingRequest
NameDescriptionTypeAdditional information
RetailerAccountNumber

integer

None.

TillID

integer

None.

PingRateMIN

integer

None.

DLLVersion

string

None.

Request Formats

application/json, text/json

Sample:
{
  "RetailerAccountNumber": 1,
  "TillID": 2,
  "PingRateMIN": 3,
  "DLLVersion": "sample string 4"
}

application/xml, text/xml

Sample:
<RetailerPingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RTVP.Common.Class">
  <DLLVersion>sample string 4</DLLVersion>
  <PingRateMIN>3</PingRateMIN>
  <RetailerAccountNumber>1</RetailerAccountNumber>
  <TillID>2</TillID>
</RetailerPingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RetailerPingResponse
NameDescriptionTypeAdditional information
ErrorCode

WebServiceErrors

None.

SendDLLVersion

boolean

None.

DefaultLimits

DefaultLimitsDTO

None.

DefaultLimitsValid

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorCode": 0,
  "SendDLLVersion": true,
  "DefaultLimits": {
    "FuelDefault": 1.1,
    "FuelReportingLimit": 2.1,
    "TobaccoDefault": 3,
    "PersonalPermitFuelDefault": 4.1,
    "PersonalPermitTobaccoDefault": 5.1,
    "SpecialOccasionPermitFuelDefault": 6.1,
    "SpecialOccasionPermitTobaccoDefault": 7.1,
    "DayTimeHoldStartTime": "00:00:00.1234567",
    "DayTimeHoldEndTime": "00:00:00.1234567"
  },
  "DefaultLimitsValid": true
}

application/xml, text/xml

Sample:
<RetailerPingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RTVP.Common.Class">
  <DefaultLimits>
    <DayTimeHoldEndTime>PT0.1234567S</DayTimeHoldEndTime>
    <DayTimeHoldStartTime>PT0.1234567S</DayTimeHoldStartTime>
    <FuelDefault>1.1</FuelDefault>
    <FuelReportingLimit>2.1</FuelReportingLimit>
    <PersonalPermitFuelDefault>4.1</PersonalPermitFuelDefault>
    <PersonalPermitTobaccoDefault>5.1</PersonalPermitTobaccoDefault>
    <SpecialOccasionPermitFuelDefault>6.1</SpecialOccasionPermitFuelDefault>
    <SpecialOccasionPermitTobaccoDefault>7.1</SpecialOccasionPermitTobaccoDefault>
    <TobaccoDefault>3</TobaccoDefault>
  </DefaultLimits>
  <DefaultLimitsValid>true</DefaultLimitsValid>
  <ErrorCode>Success</ErrorCode>
  <SendDLLVersion>true</SendDLLVersion>
</RetailerPingResponse>