Payroll | Aggregation

Service to manage entities of type 'Aggregation'.

Overview

api/{tenantKey}/{orgKey}/payrollCore/aggregations

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

All Operations

This service includes the following operations:

GET:
POST:
- POST Aggregations
PUT:
DELETE:
- DELETE Aggregation by identifier
- DELETE Aggregation by key

All Resources

This service uses the following resources:

AggregationResource
ApiAggregationResource

GET Operations

GET Aggregations

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/aggregations

GET /payrollCore/aggregations

GET Aggregations (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 AggregationResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/aggregations?page={page}&pageSize={pageSize}

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

GET Aggregation 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 AggregationResource.

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

GET /payrollCore/aggregations/{id}

GET Aggregation by key

Returns the entity record that matches the specified key.

The following elements are required:

aggregationsKey

(string) Aggregations.

Response:

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

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}/payrollCore/aggregations/{aggregationsKey}

GET /payrollCore/aggregations/{aggregationsKey}

GET Print Aggregation 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}/payrollCore/aggregations/{id}/print?template={template}

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

GET Print Aggregation by key

Prints the specified entity record.

The following elements are required:

aggregationsKey

(string) Aggregations.

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}/payrollCore/aggregations/{aggregationsKey}/print

GET /payrollCore/aggregations/{aggregationsKey}/print

GET Original Print AggregationOriginal 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}/payrollCore/aggregations/{id}/printOriginal?template={template}

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

GET Original Print Aggregation by key

Prints the specified entity record.

The following elements are required:

aggregationsKey

(string) Aggregations.

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}/payrollCore/aggregations/{aggregationsKey}/printOriginal

GET /payrollCore/aggregations/{aggregationsKey}/printOriginal

POST Operations

POST Aggregations

Creates a new entity record.

The following elements are required:

aggregationResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/aggregations

POST /payrollCore/aggregations

PUT Operations

PUT Set AggregationsKey Aggregation

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

The following elements are required:

aggregationsKey	(string) Aggregations.
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}/payrollCore/aggregations/{aggregationsKey}/aggregationsKey

PUT /payrollCore/aggregations/{aggregationsKey}/aggregationsKey

PUT Set IsActive Aggregation

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

The following elements are required:

aggregationsKey	(string) Aggregations.
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}/payrollCore/aggregations/{aggregationsKey}/isActive

PUT /payrollCore/aggregations/{aggregationsKey}/isActive

PUT Set IsEditable Aggregation

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

The following elements are required:

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

api/{tenantKey}/{orgKey}/payrollCore/aggregations/{aggregationsKey}/isEditable

PUT /payrollCore/aggregations/{aggregationsKey}/isEditable

PUT Set Name Aggregation

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

The following elements are required:

aggregationsKey	(string) Aggregations.
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}/payrollCore/aggregations/{aggregationsKey}/name

PUT /payrollCore/aggregations/{aggregationsKey}/name

DELETE Operations

DELETE Aggregation 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}/payrollCore/aggregations/{id}

DELETE /payrollCore/aggregations/{id}

DELETE Aggregation by key

Deletes the entity record that matches the specified key.

The following elements are required:

aggregationsKey

(string) Aggregations.

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}/payrollCore/aggregations/{aggregationsKey}

DELETE /payrollCore/aggregations/{aggregationsKey}

Resources

AggregationResource

The following elements are required:

aggregationsKey	(string) Aggregations.
name	(string) Name.
isEditable	(bool) Is Editable.

ApiAggregationResource

The following elements are required:

aggregationsKey	(string) Aggregations.
name	(string) Name.
isEditable	(bool) Is Editable.