Business Core | Calendar

Service to manage entities of type 'WorkCalendar'.

Overview

api/{tenantKey}/{orgKey}/businessCore/workCalendars

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

All Operations

This service includes the following operations:

GET:
POST:
- POST WorkCalendars
- POST Calendar Inactivity Period
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiWorkCalendarCalendarInactivityPeriodsResource
ApiWorkCalendarResource
WorkCalendarResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET WorkCalendars (odata)

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

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/workCalendars/odata

GET /businessCore/workCalendars/odata

GET WorkCalendar 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 WorkCalendarResource.

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/workCalendars/{id}

GET /businessCore/workCalendars/{id}

GET WorkCalendar by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
calendarKey	(string) Calendar.

Response:

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

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/workCalendars/{companyKey}/{calendarKey}

GET /businessCore/workCalendars/{companyKey}/{calendarKey}

POST Operations

POST WorkCalendars

Creates a new entity record.

The following elements are required:

workCalendarResource

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

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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 ApiWorkCalendarResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/workCalendars

POST /businessCore/workCalendars

POST Calendar Inactivity Period

Inserts a new 'Calendar Inactivity Period' in the 'Calendar'.

The following elements are required:

calendarKey	(string) Calendar.
companyKey	(string) The company key.
value	(ApiWorkCalendarCalendarInactivityPeriodsResource) The ApiWorkCalendarCalendarInactivityPeriodsResource instance. See ApiWorkCalendarCalendarInactivityPeriodsResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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/workCalendars/{companyKey}/{calendarKey}/calendarInactivityPeriods

POST /businessCore/workCalendars/{companyKey}/{calendarKey}/calendarInactivityPeriods

PUT Operations

PUT Set CalendarEventKind CalendarInactivityPeriod

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

The following elements are required:

calendarKey	(string) Calendar.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
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/workCalendars/{companyKey}/{calendarKey}/calendarInactivityPeriods/{lineId}/calendarEventKind

PUT /businessCore/workCalendars/{companyKey}/{calendarKey}/calendarInactivityPeriods/{lineId}/calendarEventKind

PUT Set CalendarKey WorkCalendar

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

The following elements are required:

calendarKey	(string) Calendar.
companyKey	(string) The company key.
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/workCalendars/{companyKey}/{calendarKey}/calendarKey

PUT /businessCore/workCalendars/{companyKey}/{calendarKey}/calendarKey

PUT Set Company WorkCalendar

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

The following elements are required:

calendarKey	(string) Calendar.
companyKey	(string) The company key.
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/workCalendars/{companyKey}/{calendarKey}/company

PUT /businessCore/workCalendars/{companyKey}/{calendarKey}/company

PUT Set Description WorkCalendar

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

The following elements are required:

calendarKey	(string) Calendar.
companyKey	(string) The company key.
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/workCalendars/{companyKey}/{calendarKey}/description

PUT /businessCore/workCalendars/{companyKey}/{calendarKey}/description

PUT Set EndDate CalendarInactivityPeriod

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

The following elements are required:

calendarKey	(string) Calendar.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
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/workCalendars/{companyKey}/{calendarKey}/calendarInactivityPeriods/{lineId}/endDate

PUT /businessCore/workCalendars/{companyKey}/{calendarKey}/calendarInactivityPeriods/{lineId}/endDate

PUT Set IsActive WorkCalendar

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

The following elements are required:

calendarKey	(string) Calendar.
companyKey	(string) The company key.
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/workCalendars/{companyKey}/{calendarKey}/isActive

PUT /businessCore/workCalendars/{companyKey}/{calendarKey}/isActive

PUT Set IsDefault WorkCalendar

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

The following elements are required:

calendarKey	(string) Calendar.
companyKey	(string) The company key.
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/workCalendars/{companyKey}/{calendarKey}/isDefault

PUT /businessCore/workCalendars/{companyKey}/{calendarKey}/isDefault

PUT Set Remarks CalendarInactivityPeriod

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

The following elements are required:

calendarKey	(string) Calendar.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
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/workCalendars/{companyKey}/{calendarKey}/calendarInactivityPeriods/{lineId}/remarks

PUT /businessCore/workCalendars/{companyKey}/{calendarKey}/calendarInactivityPeriods/{lineId}/remarks

PUT Set Remarks WorkCalendar

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

The following elements are required:

calendarKey	(string) Calendar.
companyKey	(string) The company key.
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/workCalendars/{companyKey}/{calendarKey}/remarks

PUT /businessCore/workCalendars/{companyKey}/{calendarKey}/remarks

PUT Set StartDate CalendarInactivityPeriod

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

The following elements are required:

calendarKey	(string) Calendar.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
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/workCalendars/{companyKey}/{calendarKey}/calendarInactivityPeriods/{lineId}/startDate

PUT /businessCore/workCalendars/{companyKey}/{calendarKey}/calendarInactivityPeriods/{lineId}/startDate

PUT Set Custom Attribute WorkCalendar

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
calendarKey	(string) Calendar
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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/workCalendars/{companyKey}/{calendarKey}/{customAttributeName}

PUT /businessCore/workCalendars/{companyKey}/{calendarKey}/{customAttributeName}

DELETE Operations

DELETE Calendar Inactivity Period by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

calendarKey	(string) Calendar.
companyKey	(string) The company key.
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/workCalendars/{companyKey}/{calendarKey}/calendarInactivityPeriods/{lineId}

DELETE /businessCore/workCalendars/{companyKey}/{calendarKey}/calendarInactivityPeriods/{lineId}

DELETE WorkCalendar 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/workCalendars/{id}

DELETE /businessCore/workCalendars/{id}

DELETE WorkCalendar by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
calendarKey	(string) Calendar.

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/workCalendars/{companyKey}/{calendarKey}

DELETE /businessCore/workCalendars/{companyKey}/{calendarKey}

Resources

ApiWorkCalendarCalendarInactivityPeriodsResource

The following elements are required:

calendarEventKind	(string) Calendar Event Kind.
startDate	(DateTime) Start Date.
endDate	(DateTime) End Date.

The following elements are optional:

remarks

(string) Remarks.

ApiWorkCalendarResource

The following elements are required:

calendarKey	(string) Calendar.
description	(string) Description.
company	(string) Company.

The following elements are optional:

isDefault	(bool) Is Default.
remarks	(string) Remarks.
calendarInactivityPeriods	(List of ApiWorkCalendarCalendarInactivityPeriodsResource) Calendar Inactivity Periods. See ApiWorkCalendarCalendarInactivityPeriodsResource.

WorkCalendarResource

The following elements are required:

calendarKey	(string) Calendar.
description	(string) Description.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.

The following elements are optional:

isDefault	(bool) Is Default.
remarks	(string) Remarks.
calendarInactivityPeriods	(List of CalendarInactivityPeriodResource) Calendar Inactivity Periods. See CalendarInactivityPeriodResource.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.