OfficialHoliday

Create an official holiday

POST

http://localhost:3000/api/official-holiday

curl -X POST 'http://localhost:3000/api/official-holiday' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "name": "string",
  "countryCode": "string",
  "date": "2024-01-15T09:30:00Z",
  "endDate": "2024-01-15T09:30:00Z",
  "isRecurring": true
}'

const body = `{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "name": "string",
  "countryCode": "string",
  "date": "2024-01-15T09:30:00Z",
  "endDate": "2024-01-15T09:30:00Z",
  "isRecurring": true
}`;

const response = await fetch('http://localhost:3000/api/official-holiday', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "name": "string",
  "countryCode": "string",
  "date": "2024-01-15T09:30:00Z",
  "endDate": "2024-01-15T09:30:00Z",
  "isRecurring": true
}'''

response = requests.post(
    'http://localhost:3000/api/official-holiday',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "name": "string",
  "countryCode": "string",
  "date": "2024-01-15T09:30:00Z",
  "endDate": "2024-01-15T09:30:00Z",
  "isRecurring": true
}

Body

application/json

tenantobject

tenantIdstring

organizationobjectrequired

organizationIdstringrequired

sentTostring

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

namestringrequired

Display name of the holiday, e.g. "Christmas Day"

countryCodestringrequired

ISO 3166-1 alpha-2 country code, e.g. "US", "DE"

datestring<date-time>required

The holiday date, or the first day of a multi-day holiday

endDatestring<date-time>

Last day of a multi-day holiday

isRecurringboolean

Whether the holiday falls on the same date every year

Response

201Created

The holiday has been created.

400Bad Request

Invalid input, check the response body for details

Stack Overflow Website Demo