GET api/v7/Restriction/{restrictionCode}

Retrieve the Restriction information for given Restriction Code

Request Information

URI Parameters

NameDescriptionTypeRequired?Additional information
restrictionCode *

the Restriction Code to search for

 string

Yes

None.

Body Parameters

None.

Response Information

Resource Description

Restriction Information for specified Restriction Code

RestrictionDto
NameDescriptionType
RestrictionCode

string
startDate

Start date

 date
endDate

End date

 date
startDay

Day of the week

 integer
startHour

Hour

 integer
startMinute

Minute

 integer
endDay

End day of the week

 integer
endHour

Hour

 integer
endMinute

Minute

 integer
customerAuditDate

Audit information

 date
culture

Culture Code. For example: en-US, fr, fr-CA, es, ja-JP etc.

 string
description

Description Text (Culture specific)

 string

Response Formats

application/json, text/json

Sample: 
{
  "RestrictionCode": "11",
  "startDate": "2014-07-15T15:35:34.132994-04:00",
  "endDate": "2014-07-15T15:35:34.132994-04:00",
  "startDay": 1,
  "startHour": 10,
  "startMinute": 15,
  "endDay": 5,
  "endHour": 12,
  "endMinute": 30,
  "customerAuditDate": "2018-01-01T00:00:00",
  "culture": "en-US",
  "description": "Test Restriction"
}

application/xml, text/xml

Sample: 
<Restriction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <culture>en-US</culture>
  <description>Test Restriction</description>
  <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
  <startDate>2014-07-15T15:35:34.132994-04:00</startDate>
  <endDate>2014-07-15T15:35:34.132994-04:00</endDate>
  <startDay>1</startDay>
  <startHour>10</startHour>
  <startMinute>15</startMinute>
  <endDay>5</endDay>
  <endHour>12</endHour>
  <endMinute>30</endMinute>
  <RestrictionCode>11</RestrictionCode>
</Restriction>