Valuekeep Developers - Web API Reference

Business Core | Time Schedule

Service to manage entities of type 'WorkTimeSchedule'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET WorkTimeSchedules (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 WorkTimeScheduleResource.

Response status codes:

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

Resource URL:

GET /businessCore/workTimeSchedules/odata

GET WorkTimeSchedule 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 WorkTimeScheduleResource.

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:

GET /businessCore/workTimeSchedules/{id}

GET WorkTimeSchedule by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
timeScheduleKey (string) Time Schedule.

Response:

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

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:

GET /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}

POST Operations

POST WorkTimeSchedules

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /businessCore/workTimeSchedules

POST Time Schedule Day

Inserts a new 'Time Schedule Day' in the 'Time Schedule'.

The following elements are required:

timeScheduleKey (string) Time Schedule.
companyKey (string) The company key.
value (ApiWorkTimeScheduleTimeScheduleDaysResource) The ApiWorkTimeScheduleTimeScheduleDaysResource instance.
See ApiWorkTimeScheduleTimeScheduleDaysResource.

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:

POST /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}/timeScheduleDays

PUT Operations

PUT Set Company WorkTimeSchedule

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

The following elements are required:

timeScheduleKey (string) Time Schedule.
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:

PUT /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}/company

PUT Set Day TimeScheduleDay

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

The following elements are required:

timeScheduleKey (string) Time Schedule.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (enum Day) The request body should contain the new value for the attribute.
See Day.

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:

PUT /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}/timeScheduleDays/{lineId}/day

PUT Set Description WorkTimeSchedule

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

The following elements are required:

timeScheduleKey (string) Time Schedule.
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:

PUT /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}/description

PUT Set EndTime TimeScheduleDay

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

The following elements are required:

timeScheduleKey (string) Time Schedule.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (TimeSpan) 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:

PUT /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}/timeScheduleDays/{lineId}/endTime

PUT Set IsActive WorkTimeSchedule

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

The following elements are required:

timeScheduleKey (string) Time Schedule.
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:

PUT /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}/isActive

PUT Set IsDefault WorkTimeSchedule

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

The following elements are required:

timeScheduleKey (string) Time Schedule.
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:

PUT /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}/isDefault

PUT Set Remarks WorkTimeSchedule

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

The following elements are required:

timeScheduleKey (string) Time Schedule.
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:

PUT /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}/remarks

PUT Set StartTime TimeScheduleDay

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

The following elements are required:

timeScheduleKey (string) Time Schedule.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (TimeSpan) 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:

PUT /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}/timeScheduleDays/{lineId}/startTime

PUT Set TimeScheduleKey WorkTimeSchedule

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

The following elements are required:

timeScheduleKey (string) Time Schedule.
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:

PUT /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}/timeScheduleKey

PUT Set Custom Attribute WorkTimeSchedule

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

The following elements are required:

companyKey (string) The company key.
timeScheduleKey (string) Time Schedule
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:

PUT /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}/{customAttributeName}

DELETE Operations

DELETE Time Schedule Day by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

timeScheduleKey (string) Time Schedule.
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:

DELETE /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}/timeScheduleDays/{lineId}

DELETE WorkTimeSchedule 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:

DELETE /businessCore/workTimeSchedules/{id}

DELETE WorkTimeSchedule by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
timeScheduleKey (string) Time Schedule.

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:

DELETE /businessCore/workTimeSchedules/{companyKey}/{timeScheduleKey}

Resources


ApiWorkTimeScheduleResource

The following elements are required:

timeScheduleKey (string) Time Schedule.
description (string) Description.
company (string) Company.

The following elements are optional:

isDefault (bool) Is Default.
remarks (string) Remarks.
timeScheduleDays (List of ApiWorkTimeScheduleTimeScheduleDaysResource) Time Schedule Days.
See ApiWorkTimeScheduleTimeScheduleDaysResource.


ApiWorkTimeScheduleTimeScheduleDaysResource

The following elements are required:

day (enum Day) Day.
See Day.
startTime (TimeSpan) Start Time.
endTime (TimeSpan) End Time.


WorkTimeScheduleResource

The following elements are required:

timeScheduleKey (string) Time Schedule.
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.
timeScheduleDays (List of TimeScheduleDayResource) Time Schedule Days.
See TimeScheduleDayResource.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


Day

1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday
7 Sunday