ROSEPEOPLE Developers - Web API Reference

Payroll | Work Rule Set

Service to manage entities of type 'WorkRuleSet'.

Overview


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

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /payrollCore/workRuleSets

GET WorkRuleSets (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 WorkRuleSetResource.

Response status codes:

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

Resource URL:

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

GET WorkRuleSet 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 WorkRuleSetResource.

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

GET WorkRuleSet by key

Returns the entity record that matches the specified key.

The following elements are required:

workRuleSetKey (string) Work Rule Set.

Response:

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

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/workRuleSets/{workRuleSetKey}

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

GET Print WorkRuleSet by key

Prints the specified entity record.

The following elements are required:

workRuleSetKey (string) Work Rule Set.

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/workRuleSets/{workRuleSetKey}/print

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

GET Original Print WorkRuleSet by key

Prints the specified entity record.

The following elements are required:

workRuleSetKey (string) Work Rule Set.

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/workRuleSets/{workRuleSetKey}/printOriginal

POST Operations

POST WorkRuleSets

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /payrollCore/workRuleSets

POST Work Rule Set

Inserts a new 'Work Rule Set Detail' in the 'Work Rule Set'.

The following elements are required:

workRuleSetKey (string) Work Rule Set.
value (ApiWorkRuleSetWorkRuleSetDetailsResource) The ApiWorkRuleSetWorkRuleSetDetailsResource instance.
See ApiWorkRuleSetWorkRuleSetDetailsResource.

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 /payrollCore/workRuleSets/{workRuleSetKey}/workRuleSetDetails

PUT Operations

PUT Set CurrentConfiguration WorkRuleSetDetail

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

The following elements are required:

workRuleSetKey (string) Work Rule Set.
lineId (string) The detail identifier.
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/workRuleSets/{workRuleSetKey}/workRuleSetDetails/{lineId}/currentConfiguration

PUT Set GlobalVariable WorkRuleSetDetail

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

The following elements are required:

workRuleSetKey (string) Work Rule Set.
lineId (string) The detail identifier.
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/workRuleSets/{workRuleSetKey}/workRuleSetDetails/{lineId}/globalVariable

PUT Set IsActive WorkRuleSet

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

The following elements are required:

workRuleSetKey (string) Work Rule Set.
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/workRuleSets/{workRuleSetKey}/isActive

PUT Set Name WorkRuleSet

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

The following elements are required:

workRuleSetKey (string) Work Rule Set.
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/workRuleSets/{workRuleSetKey}/name

PUT Set WorkRuleSetKey WorkRuleSet

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

The following elements are required:

workRuleSetKey (string) Work Rule Set.
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/workRuleSets/{workRuleSetKey}/workRuleSetKey

DELETE Operations

DELETE Work Rule Set Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

workRuleSetKey (string) Work Rule Set.
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 /payrollCore/workRuleSets/{workRuleSetKey}/workRuleSetDetails/{lineId}

DELETE WorkRuleSet 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/workRuleSets/{id}

DELETE WorkRuleSet by key

Deletes the entity record that matches the specified key.

The following elements are required:

workRuleSetKey (string) Work Rule Set.

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/workRuleSets/{workRuleSetKey}

Resources


ApiWorkRuleSetResource

The following elements are required:

workRuleSetKey (string) Work Rule Set.

The following elements are optional:

name (string) Name.
workRuleSetDetails (List of ApiWorkRuleSetWorkRuleSetDetailsResource) Work Rule Set Details.
See ApiWorkRuleSetWorkRuleSetDetailsResource.


ApiWorkRuleSetWorkRuleSetDetailsResource

The following elements are required:

globalVariable (string) Variable.

The following elements are optional:

workRuleSetDetailPeriods (List of ApiWorkRuleSetWorkRuleSetDetailsWorkRuleSetDetailPeriodsResource) Work Rule Set Detail Periods.
See ApiWorkRuleSetWorkRuleSetDetailsWorkRuleSetDetailPeriodsResource.
currentConfiguration (string) Current Configuration.


ApiWorkRuleSetWorkRuleSetDetailsWorkRuleSetDetailPeriodsResource

The following elements are required:

periodStart (DateTime) Start Period.
value (decimal) Value.

The following elements are optional:

periodEnd (DateTime) End Period.


WorkRuleSetDetailPeriodResource

The following elements are required:

periodStart (DateTime) Start Period.
value (decimal) Value.

The following elements are optional:

periodEnd (DateTime) End Period.


WorkRuleSetDetailResource

The following elements are required:

globalVariable (string) Variable.

The following elements are optional:

workRuleSetDetailPeriods (List of WorkRuleSetDetailPeriodResource) Work Rule Set Detail Periods.
See WorkRuleSetDetailPeriodResource.
currentConfiguration (string) Current Configuration.


WorkRuleSetResource

The following elements are required:

workRuleSetKey (string) Work Rule Set.

The following elements are optional:

name (string) Name.
workRuleSetDetails (List of WorkRuleSetDetailResource) Work Rule Set Details.
See WorkRuleSetDetailResource.