Portuguese Payroll | Dmr At Impediment Reason

Service to manage entities of type 'DmrAtImpedimentReason'.

Overview

api/{tenantKey}/{orgKey}/payrollPT/dmrAtImpedimentReasons

URL	api/{tenantKey}/{orgKey}/payrollPT/dmrAtImpedimentReasons
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST DmrAtImpedimentReasons
PUT:
DELETE:
- DELETE DmrAtImpedimentReason by identifier
- DELETE DmrAtImpedimentReason by key

All Resources

This service uses the following resources:

ApiDmrAtImpedimentReasonResource
DmrAtImpedimentReasonResource

GET Operations

GET DmrAtImpedimentReasons

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dmrAtImpedimentReasons

GET /payrollPT/dmrAtImpedimentReasons

GET DmrAtImpedimentReasons (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 DmrAtImpedimentReasonResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dmrAtImpedimentReasons?page={page}&pageSize={pageSize}

GET /payrollPT/dmrAtImpedimentReasons?page={page}&pageSize={pageSize}

GET DmrAtImpedimentReason 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 DmrAtImpedimentReasonResource.

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

GET /payrollPT/dmrAtImpedimentReasons/{id}

GET DmrAtImpedimentReason by key

Returns the entity record that matches the specified key.

The following elements are required:

code	(string) Code.

Response:

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

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}/payrollPT/dmrAtImpedimentReasons/{code}

GET /payrollPT/dmrAtImpedimentReasons/{code}

GET Print DmrAtImpedimentReason 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}/payrollPT/dmrAtImpedimentReasons/{id}/print?template={template}

GET /payrollPT/dmrAtImpedimentReasons/{id}/print?template={template}

GET Print DmrAtImpedimentReason by key

Prints the specified entity record.

The following elements are required:

code	(string) Code.

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}/payrollPT/dmrAtImpedimentReasons/{code}/print

GET /payrollPT/dmrAtImpedimentReasons/{code}/print

GET Original Print DmrAtImpedimentReasonOriginal 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}/payrollPT/dmrAtImpedimentReasons/{id}/printOriginal?template={template}

GET /payrollPT/dmrAtImpedimentReasons/{id}/printOriginal?template={template}

GET Original Print DmrAtImpedimentReason by key

Prints the specified entity record.

The following elements are required:

code	(string) Code.

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}/payrollPT/dmrAtImpedimentReasons/{code}/printOriginal

GET /payrollPT/dmrAtImpedimentReasons/{code}/printOriginal

POST Operations

POST DmrAtImpedimentReasons

Creates a new entity record.

The following elements are required:

dmrAtImpedimentReasonResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollPT/dmrAtImpedimentReasons

POST /payrollPT/dmrAtImpedimentReasons

PUT Operations

PUT Set Code DmrAtImpedimentReason

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

The following elements are required:

code	(string) Code.
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}/payrollPT/dmrAtImpedimentReasons/{code}/code

PUT /payrollPT/dmrAtImpedimentReasons/{code}/code

PUT Set Impediment DmrAtImpedimentReason

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

The following elements are required:

code	(string) Code.
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}/payrollPT/dmrAtImpedimentReasons/{code}/impediment

PUT /payrollPT/dmrAtImpedimentReasons/{code}/impediment

PUT Set IsActive DmrAtImpedimentReason

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

The following elements are required:

code	(string) Code.
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}/payrollPT/dmrAtImpedimentReasons/{code}/isActive

PUT /payrollPT/dmrAtImpedimentReasons/{code}/isActive

DELETE Operations

DELETE DmrAtImpedimentReason 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}/payrollPT/dmrAtImpedimentReasons/{id}

DELETE /payrollPT/dmrAtImpedimentReasons/{id}

DELETE DmrAtImpedimentReason by key

Deletes the entity record that matches the specified key.

The following elements are required:

code	(string) Code.

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}/payrollPT/dmrAtImpedimentReasons/{code}

DELETE /payrollPT/dmrAtImpedimentReasons/{code}

Resources

ApiDmrAtImpedimentReasonResource

The following elements are required:

code	(string) Code.

The following elements are optional:

impediment

(string) Impediment.

DmrAtImpedimentReasonResource

The following elements are required:

code	(string) Code.

The following elements are optional:

impediment

(string) Impediment.