ROSEPEOPLE Developers - Web API Reference

Payroll | Contract Dimension

Service to manage entities of type 'ContractDimension'.

Overview


URL api/{tenantKey}/{orgKey}/payrollCore/contractDimensions
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 ContractDimensions

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /payrollCore/contractDimensions

GET ContractDimensions (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 ContractDimensionResource.

Response status codes:

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

Resource URL:

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

GET ContractDimension 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 ContractDimensionResource.

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

GET ContractDimension by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
contractDimensionKey (string) Contract Dimension.

Response:

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

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/contractDimensions/{companyKey}/{contractDimensionKey}

GET Print ContractDimension 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/contractDimensions/{id}/print?template={template}

GET Print ContractDimension by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
contractDimensionKey (string) Contract Dimension.

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/contractDimensions/{companyKey}/{contractDimensionKey}/print

GET Original Print ContractDimensionOriginal 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/contractDimensions/{id}/printOriginal?template={template}

GET Original Print ContractDimension by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
contractDimensionKey (string) Contract Dimension.

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/contractDimensions/{companyKey}/{contractDimensionKey}/printOriginal

POST Operations

POST ContractDimensions

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /payrollCore/contractDimensions

PUT Operations

PUT Set Company ContractDimension

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

The following elements are required:

contractDimensionKey (string) Contract Dimension.
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/contractDimensions/{companyKey}/{contractDimensionKey}/company

PUT Set Contract ContractDimension

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

The following elements are required:

contractDimensionKey (string) Contract Dimension.
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/contractDimensions/{companyKey}/{contractDimensionKey}/contract

PUT Set ContractDimensionKey ContractDimension

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

The following elements are required:

contractDimensionKey (string) Contract Dimension.
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/contractDimensions/{companyKey}/{contractDimensionKey}/contractDimensionKey

PUT Set DimensionAllocationJson ContractDimension

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

The following elements are required:

contractDimensionKey (string) Contract Dimension.
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/contractDimensions/{companyKey}/{contractDimensionKey}/dimensionAllocationJson

PUT Set Employee ContractDimension

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

The following elements are required:

contractDimensionKey (string) Contract Dimension.
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/contractDimensions/{companyKey}/{contractDimensionKey}/employee

PUT Set IsActive ContractDimension

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

The following elements are required:

contractDimensionKey (string) Contract Dimension.
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/contractDimensions/{companyKey}/{contractDimensionKey}/isActive

PUT Set PeriodStart ContractDimension

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

The following elements are required:

contractDimensionKey (string) Contract Dimension.
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/contractDimensions/{companyKey}/{contractDimensionKey}/periodStart

DELETE Operations

DELETE ContractDimension 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/contractDimensions/{id}

DELETE ContractDimension by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
contractDimensionKey (string) Contract Dimension.

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/contractDimensions/{companyKey}/{contractDimensionKey}

Resources


ApiContractDimensionResource

The following elements are required:

contractDimensionKey (string) Contract Dimension.
contract (string) Contract.
employee (string) Employee.
periodStart (DateTime) From Period.
dimensionAllocationJson (string) The json representation of the dimension allocation.
company (string) Company.


ContractDimensionResource

The following elements are required:

contractDimensionKey (string) Contract Dimension.
contract (string) Contract.
(fk) Allowed value: the natural key of a record of type Contract. These records are accessibly through the Contracts service.
employee (string) Employee.
(fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.
periodStart (DateTime) From Period.
dimensionAllocationJson (string) The json representation of the dimension allocation.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company.