GET api/v7/Restriction
Retrieve the list of Restrictions.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
the list of Restrictions
Collection of RestrictionDto| Name | Description | Type |
|---|---|---|
| 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": "sample string 1",
"startDate": "2018-01-01T00:00:00",
"endDate": "2018-01-01T00:00:00",
"startDay": 1,
"startHour": 1,
"startMinute": 1,
"endDay": 1,
"endHour": 1,
"endMinute": 1,
"customerAuditDate": "2018-01-01T00:00:00",
"culture": "sample string 2",
"description": "sample string 3"
},
{
"RestrictionCode": "sample string 1",
"startDate": "2018-01-01T00:00:00",
"endDate": "2018-01-01T00:00:00",
"startDay": 1,
"startHour": 1,
"startMinute": 1,
"endDay": 1,
"endHour": 1,
"endMinute": 1,
"customerAuditDate": "2018-01-01T00:00:00",
"culture": "sample string 2",
"description": "sample string 3"
}
]
application/xml, text/xml
Sample:
<ArrayOfRestrictionDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<RestrictionDto>
<culture>sample string 2</culture>
<description>sample string 3</description>
<customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
<startDate>2018-01-01T00:00:00</startDate>
<endDate>2018-01-01T00:00:00</endDate>
<startDay>1</startDay>
<startHour>1</startHour>
<startMinute>1</startMinute>
<endDay>1</endDay>
<endHour>1</endHour>
<endMinute>1</endMinute>
<RestrictionCode>sample string 1</RestrictionCode>
</RestrictionDto>
<RestrictionDto>
<culture>sample string 2</culture>
<description>sample string 3</description>
<customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
<startDate>2018-01-01T00:00:00</startDate>
<endDate>2018-01-01T00:00:00</endDate>
<startDay>1</startDay>
<startHour>1</startHour>
<startMinute>1</startMinute>
<endDay>1</endDay>
<endHour>1</endHour>
<endMinute>1</endMinute>
<RestrictionCode>sample string 1</RestrictionCode>
</RestrictionDto>
</ArrayOfRestrictionDto>