Holiday Sets
List Holiday Sets
The holiday_set
endpoint allows clients to retrieve the full list of
holiday sets available to the current customer.
GET /api/customer/:customer_id/holiday_set
Retrieve a list of holiday sets configured in the underlying OCNCC system which the current authenticated user has access to.
This API endpoint supports no parameters.
Response Content
The response will be a JSON array of objects, with each object consisting of the following information:
Key | Type | Description |
---|---|---|
id |
Integer | The unique ID of the holiday set. |
entries |
Array | An array of objects representing each configured holiday in the holiday set. |
name |
String | The full name of the holiday set. |
Each Entry in the entries
array is an object, an consists of the following information:
Key | Type | Description |
---|---|---|
id |
Integer | The unique ID of the holiday entry. |
name |
String | The full name of the holiday entry in the set. |
Examples
Request:
curl 'http://localhost/jarvis-agent/n2fe/api/customer/1234/holiday_set' -H 'Cookie: N2FE_CGISESSID=48ac880f98504e81373207d62dd2f807'
Response:
[
{
"id" : "54",
"entries" : [
{
"id" : "137",
"name" : "Anzac Day"
},
{
"name" : "Anzac Day Holiday",
"id" : "138"
},
{
"id" : "133",
"name" : "Australia Day"
},
{
"name" : "Boxing Day",
"id" : "144"
},
...
],
"name" : "ACT/NAT Holiday"
},
...
]