People | Schedule

Service to manage entities of type 'Schedule'.

Overview

api/{tenantKey}/{orgKey}/peopleCore/schedules

URL	api/{tenantKey}/{orgKey}/peopleCore/schedules
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Schedules
- POST Schedule
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiScheduleResource
ApiScheduleScheduleDaysResource
ScheduleDayResource
ScheduleResource

All Enumerations

This service uses the following enumerations:

ScheduleType

GET Operations

GET Schedules

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/schedules

GET /peopleCore/schedules

GET Schedules (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 ScheduleResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/schedules?page={page}&pageSize={pageSize}

GET /peopleCore/schedules?page={page}&pageSize={pageSize}

GET Schedule 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 ScheduleResource.

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

GET /peopleCore/schedules/{id}

GET Schedule by key

Returns the entity record that matches the specified key.

The following elements are required:

scheduleKey

(string) Schedule.

Response:

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

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}/peopleCore/schedules/{scheduleKey}

GET /peopleCore/schedules/{scheduleKey}

GET Print Schedule 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}/peopleCore/schedules/{id}/print?template={template}

GET /peopleCore/schedules/{id}/print?template={template}

GET Print Schedule by key

Prints the specified entity record.

The following elements are required:

scheduleKey

(string) Schedule.

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}/peopleCore/schedules/{scheduleKey}/print

GET /peopleCore/schedules/{scheduleKey}/print

GET Original Print ScheduleOriginal 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}/peopleCore/schedules/{id}/printOriginal?template={template}

GET /peopleCore/schedules/{id}/printOriginal?template={template}

GET Original Print Schedule by key

Prints the specified entity record.

The following elements are required:

scheduleKey

(string) Schedule.

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}/peopleCore/schedules/{scheduleKey}/printOriginal

GET /peopleCore/schedules/{scheduleKey}/printOriginal

POST Operations

POST Schedules

Creates a new entity record.

The following elements are required:

scheduleResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/schedules

POST /peopleCore/schedules

POST Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
value	(ApiScheduleScheduleDaysResource) The ApiScheduleScheduleDaysResource instance. See ApiScheduleScheduleDaysResource.

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}/peopleCore/schedules/{scheduleKey}/scheduleDays

POST /peopleCore/schedules/{scheduleKey}/scheduleDays

PUT Operations

PUT Set Date ScheduleDay

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

The following elements are required:

scheduleKey	(string) Schedule.
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}/peopleCore/schedules/{scheduleKey}/scheduleDays/{lineId}/date

PUT /peopleCore/schedules/{scheduleKey}/scheduleDays/{lineId}/date

PUT Set ExpiryDate Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
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}/peopleCore/schedules/{scheduleKey}/expiryDate

PUT /peopleCore/schedules/{scheduleKey}/expiryDate

PUT Set Friday Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
value	(decimal) 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}/peopleCore/schedules/{scheduleKey}/friday

PUT /peopleCore/schedules/{scheduleKey}/friday

PUT Set Hours ScheduleDay

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

The following elements are required:

scheduleKey	(string) Schedule.
lineId	(string) The detail identifier.
value	(decimal) 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}/peopleCore/schedules/{scheduleKey}/scheduleDays/{lineId}/hours

PUT /peopleCore/schedules/{scheduleKey}/scheduleDays/{lineId}/hours

PUT Set HoursPerWeek Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
value	(decimal) 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}/peopleCore/schedules/{scheduleKey}/hoursPerWeek

PUT /peopleCore/schedules/{scheduleKey}/hoursPerWeek

PUT Set IsActive Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
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}/peopleCore/schedules/{scheduleKey}/isActive

PUT /peopleCore/schedules/{scheduleKey}/isActive

PUT Set Monday Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
value	(decimal) 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}/peopleCore/schedules/{scheduleKey}/monday

PUT /peopleCore/schedules/{scheduleKey}/monday

PUT Set Name Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
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}/peopleCore/schedules/{scheduleKey}/name

PUT /peopleCore/schedules/{scheduleKey}/name

PUT Set Saturday Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
value	(decimal) 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}/peopleCore/schedules/{scheduleKey}/saturday

PUT /peopleCore/schedules/{scheduleKey}/saturday

PUT Set ScheduleDaysJson Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
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}/peopleCore/schedules/{scheduleKey}/scheduleDaysJson

PUT /peopleCore/schedules/{scheduleKey}/scheduleDaysJson

PUT Set ScheduleKey Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
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}/peopleCore/schedules/{scheduleKey}/scheduleKey

PUT /peopleCore/schedules/{scheduleKey}/scheduleKey

PUT Set ScheduleType Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
value	(enum ScheduleType) The request body should contain the new value for the attribute. See ScheduleType.

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}/peopleCore/schedules/{scheduleKey}/scheduleType

PUT /peopleCore/schedules/{scheduleKey}/scheduleType

PUT Set Sunday Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
value	(decimal) 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}/peopleCore/schedules/{scheduleKey}/sunday

PUT /peopleCore/schedules/{scheduleKey}/sunday

PUT Set Thursday Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
value	(decimal) 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}/peopleCore/schedules/{scheduleKey}/thursday

PUT /peopleCore/schedules/{scheduleKey}/thursday

PUT Set Tuesday Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
value	(decimal) 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}/peopleCore/schedules/{scheduleKey}/tuesday

PUT /peopleCore/schedules/{scheduleKey}/tuesday

PUT Set Wednesday Schedule

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

The following elements are required:

scheduleKey	(string) Schedule.
value	(decimal) 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}/peopleCore/schedules/{scheduleKey}/wednesday

PUT /peopleCore/schedules/{scheduleKey}/wednesday

DELETE Operations

DELETE Schedule Day by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

scheduleKey	(string) Schedule.
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}/peopleCore/schedules/{scheduleKey}/scheduleDays/{lineId}

DELETE /peopleCore/schedules/{scheduleKey}/scheduleDays/{lineId}

DELETE Schedule 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}/peopleCore/schedules/{id}

DELETE /peopleCore/schedules/{id}

DELETE Schedule by key

Deletes the entity record that matches the specified key.

The following elements are required:

scheduleKey

(string) 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:

api/{tenantKey}/{orgKey}/peopleCore/schedules/{scheduleKey}

DELETE /peopleCore/schedules/{scheduleKey}

Resources

ApiScheduleResource

The following elements are required:

scheduleKey	(string) Schedule.
name	(string) Name.
monday	(decimal) Monday.
tuesday	(decimal) Tuesday.
wednesday	(decimal) Wednesday.
thursday	(decimal) Thursday.
friday	(decimal) Friday.
saturday	(decimal) Saturday.
sunday	(decimal) Sunday.
scheduleType	(enum ScheduleType) Schedule Type. See ScheduleType.

The following elements are optional:

hoursPerWeek	(decimal) Hours Per Week.
scheduleDays	(List of ApiScheduleScheduleDaysResource) Schedule Days. See ApiScheduleScheduleDaysResource.
scheduleDaysJson	(string) Schedule Days Json.
expiryDate	(DateTime) Expiry Date.

ApiScheduleScheduleDaysResource

The following elements are optional:

date	(DateTime) Date.
hours	(decimal) Hours.

ScheduleDayResource

The following elements are optional:

date	(DateTime) Date.
hours	(decimal) Hours.

ScheduleResource

The following elements are required:

scheduleKey	(string) Schedule.
name	(string) Name.
monday	(decimal) Monday.
tuesday	(decimal) Tuesday.
wednesday	(decimal) Wednesday.
thursday	(decimal) Thursday.
friday	(decimal) Friday.
saturday	(decimal) Saturday.
sunday	(decimal) Sunday.
scheduleType	(enum ScheduleType) Schedule Type. See ScheduleType.

The following elements are optional:

hoursPerWeek	(decimal) Hours Per Week.
scheduleDays	(List of ScheduleDayResource) Schedule Days. See ScheduleDayResource.
scheduleDaysJson	(string) Schedule Days Json.
expiryDate	(DateTime) Expiry Date.

Enumerations

ScheduleType

1	Steady
2	Changeable