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

Request Information

URI Parameters

Name	Description	Type	Additional information
accessCode		string	Required

Body Parameters

None.

Response Information

Resource Description

AccessCodeValidationResponse

Name	Type	Additional information
IsValid	boolean	None.
IsShippable	boolean	None.
CountryRestriction	boolean	None.
EligibleCountries	Collection of EligibleCountry	None.
Message	ServiceMessage	None.
ProductName	string	None.
CodeType	OptionSetValues	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",
  "CodeType": {
    "Value": 1,
    "Label": "sample string 2"
  }
}

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">
  <CodeType>
    <Label>sample string 2</Label>
    <Value>1</Value>
  </CodeType>
  <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>