ROSEPEOPLE Developers - Web API Reference

Payroll | Contract Schedule

Service to manage entities of type 'ContractSchedule'.

Overview


URL api/{tenantKey}/{orgKey}/payrollCore/contractSchedules
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET ContractSchedules

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /payrollCore/contractSchedules

GET ContractSchedules (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 ContractScheduleResource.

Response status codes:

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

Resource URL:

GET /payrollCore/contractSchedules?page={page}&pageSize={pageSize}

GET ContractSchedule 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 ContractScheduleResource.

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

GET ContractSchedule by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
contractScheduleKey (string) Contract Schedule.

Response:

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

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 /payrollCore/contractSchedules/{companyKey}/{contractScheduleKey}

GET Print ContractSchedule 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:

GET /payrollCore/contractSchedules/{id}/print?template={template}

GET Print ContractSchedule by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
contractScheduleKey (string) Contract 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:

GET /payrollCore/contractSchedules/{companyKey}/{contractScheduleKey}/print

GET Original Print ContractScheduleOriginal 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:

GET /payrollCore/contractSchedules/{id}/printOriginal?template={template}

GET Original Print ContractSchedule by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
contractScheduleKey (string) Contract 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:

GET /payrollCore/contractSchedules/{companyKey}/{contractScheduleKey}/printOriginal

POST Operations

POST ContractSchedules

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /payrollCore/contractSchedules

PUT Operations

PUT Set Company ContractSchedule

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

The following elements are required:

contractScheduleKey (string) Contract 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 /payrollCore/contractSchedules/{companyKey}/{contractScheduleKey}/company

PUT Set Contract ContractSchedule

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

The following elements are required:

contractScheduleKey (string) Contract 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 /payrollCore/contractSchedules/{companyKey}/{contractScheduleKey}/contract

PUT Set ContractScheduleKey ContractSchedule

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

The following elements are required:

contractScheduleKey (string) Contract 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 /payrollCore/contractSchedules/{companyKey}/{contractScheduleKey}/contractScheduleKey

PUT Set EndDate ContractSchedule

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

The following elements are required:

contractScheduleKey (string) Contract Schedule.
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:

PUT /payrollCore/contractSchedules/{companyKey}/{contractScheduleKey}/endDate

PUT Set IsActive ContractSchedule

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

The following elements are required:

contractScheduleKey (string) Contract 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 /payrollCore/contractSchedules/{companyKey}/{contractScheduleKey}/isActive

PUT Set OverlapCalendar ContractSchedule

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

The following elements are required:

contractScheduleKey (string) Contract 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 /payrollCore/contractSchedules/{companyKey}/{contractScheduleKey}/overlapCalendar

PUT Set Schedule ContractSchedule

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

The following elements are required:

contractScheduleKey (string) Contract 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 /payrollCore/contractSchedules/{companyKey}/{contractScheduleKey}/schedule

PUT Set StartDate ContractSchedule

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

The following elements are required:

contractScheduleKey (string) Contract Schedule.
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:

PUT /payrollCore/contractSchedules/{companyKey}/{contractScheduleKey}/startDate

DELETE Operations

DELETE ContractSchedule 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 /payrollCore/contractSchedules/{id}

DELETE ContractSchedule by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
contractScheduleKey (string) Contract 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 /payrollCore/contractSchedules/{companyKey}/{contractScheduleKey}

Resources


ApiContractScheduleResource

The following elements are required:

contractScheduleKey (string) Contract Schedule.
contract (string) Contract.
schedule (string) Schedule.
startDate (DateTime) Start Date.
overlapCalendar (bool) Overlap Calendar.
company (string) Company.

The following elements are optional:

endDate (DateTime) End Date.


ContractScheduleResource

The following elements are required:

contractScheduleKey (string) Contract Schedule.
contract (string) Contract.
(fk) Allowed value: the natural key of a record of type Contract. These records are accessibly through the Contracts service.
schedule (string) Schedule.
(fk) Allowed value: the natural key of a record of type Schedule. These records are accessibly through the Schedules service.
startDate (DateTime) Start Date.
overlapCalendar (bool) Overlap Calendar.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company.

The following elements are optional:

endDate (DateTime) End Date.