GET api/SpecialOffer/Validate?apiKey={apiKey}&specialOfferID={specialOfferID}&locationID={locationID}&startOn={startOn}&endOn={endOn}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiKey

string

Required
specialOfferID

globally unique identifier

Required
locationID

globally unique identifier

Required
startOn

date

Required
endOn

date

Required

Body Parameters

None.

Response Information

Resource Description

Result
NameDescriptionTypeAdditional information
IsValid

boolean

None.
Message

string

None.
Code

string

None.
ID

globally unique identifier

None.
Errors

Collection of string

None.
ErrorCodes

Collection of ErrorCode

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsValid": true,
  "Message": "sample string 2",
  "Code": "sample string 3",
  "ID": "2642bb08-4294-48a6-a72f-32650246b2ed",
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "ErrorCodes": [
    1,
    1
  ]
}

application/xml, text/xml

Sample: 
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetlet.Entity">
  <Code>sample string 3</Code>
  <ErrorCodes>
    <ErrorCode>Success</ErrorCode>
    <ErrorCode>Success</ErrorCode>
  </ErrorCodes>
  <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>
  <ID>2642bb08-4294-48a6-a72f-32650246b2ed</ID>
  <IsValid>true</IsValid>
  <Message>sample string 2</Message>
</Result>