GET api/accesscode/validate?accessCode={accessCode}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accessCode

string

Required

Body Parameters

None.

Response Information

Resource Description

AccessCodeValidationResponse
NameDescriptionTypeAdditional information
IsValid

boolean

None.

IsShippable

boolean

None.

CountryRestriction

boolean

None.

EligibleCountries

Collection of EligibleCountry

None.

Message

ServiceMessage

None.

ProductName

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsValid": true,
  "IsShippable": true,
  "CountryRestriction": true,
  "EligibleCountries": [
    {
      "Id": "sample string 1"
    },
    {
      "Id": "sample string 1"
    }
  ],
  "Message": {
    "MessageCode": "sample string 1",
    "MessageType": "sample string 2",
    "MessageDescription": "sample string 3"
  },
  "ProductName": "sample string 4"
}

application/xml, text/xml

Sample:
<AccessCodeValidationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
  <CountryRestriction>true</CountryRestriction>
  <EligibleCountries>
    <EligibleCountry>
      <Id>sample string 1</Id>
    </EligibleCountry>
    <EligibleCountry>
      <Id>sample string 1</Id>
    </EligibleCountry>
  </EligibleCountries>
  <IsShippable>true</IsShippable>
  <IsValid>true</IsValid>
  <Message>
    <MessageCode>sample string 1</MessageCode>
    <MessageDescription>sample string 3</MessageDescription>
    <MessageType>sample string 2</MessageType>
  </Message>
  <ProductName>sample string 4</ProductName>
</AccessCodeValidationResponse>