Master Data Business Entities | Non Working Day

The Non Working Day represents information of unique or repetitive events that will appear on the calendar such as national or local holidays.

Overview

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays

URL	api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST NonWorkingDays
- POST Non Working Day
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiNonWorkingDayNonWorkingDayLinesResource
ApiNonWorkingDayResource
NonWorkDaysResource
NonWorkingDayLineResource
NonWorkingDayResource

All Enumerations

This service uses the following enumerations:

NonWorkingDayType

GET Operations

GET NonWorkingDays

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See NonWorkingDayResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays

GET /businessCore/nonWorkingDays

GET NonWorkingDays (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See NonWorkingDayResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays?page={page}&pageSize={pageSize}

GET /businessCore/nonWorkingDays?page={page}&pageSize={pageSize}

GET NonWorkingDay by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See NonWorkingDayResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{id}

GET /businessCore/nonWorkingDays/{id}

GET NonWorkingDay by key

Returns the entity record that matches the specified key.

The following elements are required:

nonWorkingDayKey

(string) The Key for the non working day.

Response:

When successful, the response body contains the entity record. See NonWorkingDayResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}

GET /businessCore/nonWorkingDays/{nonWorkingDayKey}

GET Print NonWorkingDay by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{id}/print?template={template}

GET /businessCore/nonWorkingDays/{id}/print?template={template}

GET Print NonWorkingDay by key

Prints the specified entity record.

The following elements are required:

nonWorkingDayKey

(string) The Key for the non working day.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}/print

GET /businessCore/nonWorkingDays/{nonWorkingDayKey}/print

GET Original Print NonWorkingDayOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{id}/printOriginal?template={template}

GET /businessCore/nonWorkingDays/{id}/printOriginal?template={template}

GET Original Print NonWorkingDay by key

Prints the specified entity record.

The following elements are required:

nonWorkingDayKey

(string) The Key for the non working day.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}/printOriginal

GET /businessCore/nonWorkingDays/{nonWorkingDayKey}/printOriginal

GET Get non working days by Year

This operation gets all non working days for a specific year based on the non working code.

The following elements are required:

nonWorkingDayKey	(string) Non working day key.
year	(int) The year to get the non working days.

Response:

When successful, the response body contains a list of resources of type 'NonWorkDaysResource'. See NonWorkDaysResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/getNonWorkingDaysByYear/{nonWorkingDayKey}/{year}

GET /businessCore/nonWorkingDays/getNonWorkingDaysByYear/{nonWorkingDayKey}/{year}

GET Get non working days by Period

This operation gets all non working days for a specific period based on the non working code.

The following elements are required:

nonWorkingDayKey	(string) Non working day key.
startDate	(DateTime?) The start date to get the non working days.
endDate	(DateTime?) The end date to get the non working days.

Response:

When successful, the response body contains a list of resources of type 'NonWorkDaysResource'. See NonWorkDaysResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/getNonWorkingDaysByPeriod/{nonWorkingDayKey}

GET /businessCore/nonWorkingDays/getNonWorkingDaysByPeriod/{nonWorkingDayKey}

POST Operations

POST NonWorkingDays

Creates a new entity record.

The following elements are required:

nonWorkingDayResource

(ApiNonWorkingDayResource) The request body should contain the entity record that should be created.
See ApiNonWorkingDayResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiNonWorkingDayResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays

POST /businessCore/nonWorkingDays

POST Non Working Day

Inserts a new 'Non working days' in the 'Non Working Day'.

The following elements are required:

nonWorkingDayKey	(string) The Key for the non working day.
value	(ApiNonWorkingDayNonWorkingDayLinesResource) The ApiNonWorkingDayNonWorkingDayLinesResource instance. See ApiNonWorkingDayNonWorkingDayLinesResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayLines

POST /businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayLines

PUT Operations

PUT Set BaseNonWorkingDay NonWorkingDay

Updates the value of attribute 'BaseNonWorkingDay' in the specified entity record.

The following elements are required:

nonWorkingDayKey	(string) The Key for the non working day.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}/baseNonWorkingDay

PUT /businessCore/nonWorkingDays/{nonWorkingDayKey}/baseNonWorkingDay

PUT Set Date NonWorkingDayLine

Updates the value of attribute 'Date' in the specified entity record.

The following elements are required:

nonWorkingDayKey	(string) The Key for the non working day.
lineId	(string) The detail identifier.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayLines/{lineId}/date

PUT /businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayLines/{lineId}/date

PUT Set Description NonWorkingDay

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

nonWorkingDayKey	(string) The Key for the non working day.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}/description

PUT /businessCore/nonWorkingDays/{nonWorkingDayKey}/description

PUT Set Description NonWorkingDayLine

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

nonWorkingDayKey	(string) The Key for the non working day.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayLines/{lineId}/description

PUT /businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayLines/{lineId}/description

PUT Set IsActive NonWorkingDay

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

nonWorkingDayKey	(string) The Key for the non working day.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}/isActive

PUT /businessCore/nonWorkingDays/{nonWorkingDayKey}/isActive

PUT Set NonWorkingDayKey NonWorkingDay

Updates the value of attribute 'NonWorkingDayKey' in the specified entity record.

The following elements are required:

nonWorkingDayKey	(string) The Key for the non working day.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayKey

PUT /businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayKey

PUT Set NonWorkingDayType NonWorkingDayLine

Updates the value of attribute 'NonWorkingDayType' in the specified entity record.

The following elements are required:

nonWorkingDayKey	(string) The Key for the non working day.
lineId	(string) The detail identifier.
value	(enum NonWorkingDayType) The request body should contain the new value for the attribute. See NonWorkingDayType.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayLines/{lineId}/nonWorkingDayType

PUT /businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayLines/{lineId}/nonWorkingDayType

PUT Set SingleEvent NonWorkingDayLine

Updates the value of attribute 'SingleEvent' in the specified entity record.

The following elements are required:

nonWorkingDayKey	(string) The Key for the non working day.
lineId	(string) The detail identifier.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayLines/{lineId}/singleEvent

PUT /businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayLines/{lineId}/singleEvent

DELETE Operations

DELETE Non working days by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

nonWorkingDayKey	(string) The Key for the non working day.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayLines/{lineId}

DELETE /businessCore/nonWorkingDays/{nonWorkingDayKey}/nonWorkingDayLines/{lineId}

DELETE NonWorkingDay by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{id}

DELETE /businessCore/nonWorkingDays/{id}

DELETE NonWorkingDay by key

Deletes the entity record that matches the specified key.

The following elements are required:

nonWorkingDayKey

(string) The Key for the non working day.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/nonWorkingDays/{nonWorkingDayKey}

DELETE /businessCore/nonWorkingDays/{nonWorkingDayKey}

Resources

ApiNonWorkingDayNonWorkingDayLinesResource

The following elements are required:

date	(DateTime) The Start Date for the non working day line.
nonWorkingDayType	(enum NonWorkingDayType) The type for the non working day line. See NonWorkingDayType.
singleEvent	(bool) The single event if true the event occurs one time otherwise every year.

The following elements are optional:

description

(string) The description for the non working day line.

ApiNonWorkingDayResource

The following elements are required:

nonWorkingDayKey

(string) The Key for the non working day.

The following elements are optional:

description	(string) The description for the non working day.
baseNonWorkingDay	(string) The base non working day refer a non working day that have already been created.
nonWorkingDayLines	(List of ApiNonWorkingDayNonWorkingDayLinesResource) The non working day detail. See ApiNonWorkingDayNonWorkingDayLinesResource.

NonWorkDaysResource

The following elements are optional:

date	(DateTime) The date of the non working day.
description	(string) The description of the non working day.

NonWorkingDayLineResource

The following elements are required:

date	(DateTime) The Start Date for the non working day line.
nonWorkingDayType	(enum NonWorkingDayType) The type for the non working day line. See NonWorkingDayType.
singleEvent	(bool) The single event if true the event occurs one time otherwise every year.

The following elements are optional:

description

(string) The description for the non working day line.

NonWorkingDayResource

The following elements are required:

nonWorkingDayKey

(string) The Key for the non working day.

The following elements are optional:

description	(string) The description for the non working day.
baseNonWorkingDay	(string) The base non working day refer a non working day that have already been created. (fk) Allowed value: the natural key of a record of type NonWorkingDay. These records are accessibly through the NonWorkingDays service.
nonWorkingDayLines	(List of NonWorkingDayLineResource) The non working day detail. See NonWorkingDayLineResource.

Enumerations

NonWorkingDayType

1	FixedDate	Fixed date will alter the year of the date.
2	Carnival	Carnival a new date will be calculated based on the year.
3	GoodFriday	Good Friday a new date will be calculated based on the year.
4	Easter	Easter a new date will be calculated based on the year.
5	CorpusChristi	Corpus Christi a new date will be calculated based on the year.