Update 'README.md'

This commit is contained in:
brajkovic 2023-08-25 06:07:35 +00:00
parent 4c45d00989
commit 99c5e5cd13
1 changed files with 99 additions and 95 deletions

View File

@ -55,25 +55,29 @@ That endpoint accepts a list of required and optional parameters
By default, responses are returned as a json array
```
[{
id: string;
date: string(ISO 8601);
name: string;
description: string;
isStateHoliday: boolean;
isReligiousHoliday: boolean;
},...]
{
holidays: [{
id: string;
date: string(ISO 8601);
name: string;
description: string;
isStateHoliday: boolean;
isReligiousHoliday: boolean;
},...]
}
```
eg.
```
[{
"id": "74a2a769-abf2-45d4-bdc4-442bbcc89138",
"date": "2023-12-25",
"name": "Christmas",
"description": "TBD",
"isStateHoliday": true,
"isReligiousHoliday": true
}]
{
"holidays": [{
"id": "74a2a769-abf2-45d4-bdc4-442bbcc89138",
"date": "2023-12-25",
"name": "Christmas",
"description": "TBD",
"isStateHoliday": true,
"isReligiousHoliday": true
}]
}
```
But can be returned as XML or CSV by setting appropriate `Accept` header (application/xml, text/xml or text/csv)