Payroll | Tag

Service to manage entities of type 'Tag'.

Overview

api/{tenantKey}/{orgKey}/payrollCore/tags

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

All Operations

This service includes the following operations:

GET:
POST:
- POST Tags
PUT:
- PUT Set IsActive Tag
- PUT Set TagKey Tag
DELETE:
- DELETE Tag by identifier
- DELETE Tag by key

All Resources

This service uses the following resources:

ApiTagResource
TagResource

GET Operations

GET Tags

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/tags

GET /payrollCore/tags

GET Tags (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 TagResource.

Response status codes:

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

Resource URL:

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

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

GET Tag 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 TagResource.

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

GET /payrollCore/tags/{id}

GET Tag by key

Returns the entity record that matches the specified key.

The following elements are required:

tagKey

(string) Tag.

Response:

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

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/tags/{tagKey}

GET /payrollCore/tags/{tagKey}

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

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

GET Print Tag by key

Prints the specified entity record.

The following elements are required:

tagKey

(string) Tag.

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/tags/{tagKey}/print

GET /payrollCore/tags/{tagKey}/print

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

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

GET Original Print Tag by key

Prints the specified entity record.

The following elements are required:

tagKey

(string) Tag.

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/tags/{tagKey}/printOriginal

GET /payrollCore/tags/{tagKey}/printOriginal

POST Operations

POST Tags

Creates a new entity record.

The following elements are required:

tagResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/tags

POST /payrollCore/tags

PUT Operations

PUT Set IsActive Tag

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

The following elements are required:

tagKey	(string) Tag.
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/tags/{tagKey}/isActive

PUT /payrollCore/tags/{tagKey}/isActive

PUT Set TagKey Tag

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

The following elements are required:

tagKey	(string) Tag.
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/tags/{tagKey}/tagKey

PUT /payrollCore/tags/{tagKey}/tagKey

DELETE Operations

DELETE Tag 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/tags/{id}

DELETE /payrollCore/tags/{id}

DELETE Tag by key

Deletes the entity record that matches the specified key.

The following elements are required:

tagKey

(string) Tag.

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/tags/{tagKey}

DELETE /payrollCore/tags/{tagKey}

Resources

ApiTagResource

The following elements are required:

tagKey

(string) Tag.

TagResource

The following elements are required:

tagKey

(string) Tag.