ROSEPEOPLE Developers - Web API Reference

Payroll | Global Variable

Service to manage entities of type 'GlobalVariable'.

Overview


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

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /payrollCore/globalVariables

GET GlobalVariables (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 GlobalVariableResource.

Response status codes:

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

Resource URL:

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

GET GlobalVariable 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 GlobalVariableResource.

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

GET GlobalVariable by key

Returns the entity record that matches the specified key.

The following elements are required:

variableKey (string) Variable.

Response:

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

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/globalVariables/{variableKey}

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

GET Print GlobalVariable by key

Prints the specified entity record.

The following elements are required:

variableKey (string) Variable.

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/globalVariables/{variableKey}/print

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

GET Original Print GlobalVariable by key

Prints the specified entity record.

The following elements are required:

variableKey (string) Variable.

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/globalVariables/{variableKey}/printOriginal

POST Operations

POST GlobalVariables

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /payrollCore/globalVariables

POST Global Variable

Inserts a new 'Global Variable Detail' in the 'Global Variable'.

The following elements are required:

variableKey (string) Variable.
value (ApiGlobalVariableGlobalVariableDetailsResource) The ApiGlobalVariableGlobalVariableDetailsResource instance.
See ApiGlobalVariableGlobalVariableDetailsResource.

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/globalVariables/{variableKey}/globalVariableDetails

PUT Operations

PUT Set Designation GlobalVariable

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

The following elements are required:

variableKey (string) Variable.
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/globalVariables/{variableKey}/designation

PUT Set EndPeriod GlobalVariableDetail

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

The following elements are required:

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

PUT /payrollCore/globalVariables/{variableKey}/globalVariableDetails/{lineId}/endPeriod

PUT Set IsActive GlobalVariable

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

The following elements are required:

variableKey (string) Variable.
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/globalVariables/{variableKey}/isActive

PUT Set StartPeriod GlobalVariableDetail

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

The following elements are required:

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

PUT /payrollCore/globalVariables/{variableKey}/globalVariableDetails/{lineId}/startPeriod

PUT Set Value GlobalVariableDetail

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

The following elements are required:

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

PUT /payrollCore/globalVariables/{variableKey}/globalVariableDetails/{lineId}/value

PUT Set VariableKey GlobalVariable

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

The following elements are required:

variableKey (string) Variable.
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/globalVariables/{variableKey}/variableKey

DELETE Operations

DELETE Global Variable Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

variableKey (string) Variable.
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/globalVariables/{variableKey}/globalVariableDetails/{lineId}

DELETE GlobalVariable 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/globalVariables/{id}

DELETE GlobalVariable by key

Deletes the entity record that matches the specified key.

The following elements are required:

variableKey (string) Variable.

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/globalVariables/{variableKey}

Resources


ApiGlobalVariableGlobalVariableDetailsResource

The following elements are required:

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

The following elements are optional:

endPeriod (DateTime) End Period.


ApiGlobalVariableResource

The following elements are required:

variableKey (string) Variable.

The following elements are optional:

designation (string) Designation.
globalVariableDetails (List of ApiGlobalVariableGlobalVariableDetailsResource) Global Variable Details.
See ApiGlobalVariableGlobalVariableDetailsResource.


GlobalVariableDetailResource

The following elements are required:

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

The following elements are optional:

endPeriod (DateTime) End Period.


GlobalVariableResource

The following elements are required:

variableKey (string) Variable.

The following elements are optional:

designation (string) Designation.
globalVariableDetails (List of GlobalVariableDetailResource) Global Variable Details.
See GlobalVariableDetailResource.