ROSEPEOPLE Developers - Web API Reference

Portuguese Payroll | Single Report Mapping

Service to manage entities of type 'SingleReportMapping'.

Overview


URL api/{tenantKey}/{orgKey}/payrollPT/singleReportMappings
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 SingleReportMappings

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /payrollPT/singleReportMappings

GET SingleReportMappings (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 SingleReportMappingResource.

Response status codes:

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

Resource URL:

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

GET SingleReportMapping 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 SingleReportMappingResource.

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

GET SingleReportMapping by key

Returns the entity record that matches the specified key.

The following elements are required:

key (string) Key.

Response:

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

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 /payrollPT/singleReportMappings/{key}

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

GET Print SingleReportMapping by key

Prints the specified entity record.

The following elements are required:

key (string) Key.

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 /payrollPT/singleReportMappings/{key}/print

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

GET Original Print SingleReportMapping by key

Prints the specified entity record.

The following elements are required:

key (string) Key.

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 /payrollPT/singleReportMappings/{key}/printOriginal

POST Operations

POST SingleReportMappings

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /payrollPT/singleReportMappings

POST Single Report Mapping

Inserts a new 'Single Report Mapping Detail' in the 'Single Report Mapping'.

The following elements are required:

key (string) Key.
value (ApiSingleReportMappingSingleReportMappingDetailsResource) The ApiSingleReportMappingSingleReportMappingDetailsResource instance.
See ApiSingleReportMappingSingleReportMappingDetailsResource.

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 /payrollPT/singleReportMappings/{key}/singleReportMappingDetails

PUT Operations

PUT Set IsActive SingleReportMapping

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

The following elements are required:

key (string) Key.
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 /payrollPT/singleReportMappings/{key}/isActive

PUT Set Key SingleReportMapping

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

The following elements are required:

key (string) Key.
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 /payrollPT/singleReportMappings/{key}/key

PUT Set Name SingleReportMapping

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

The following elements are required:

key (string) Key.
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 /payrollPT/singleReportMappings/{key}/name

PUT Set SingleReportMappingCode SingleReportMappingDetail

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

The following elements are required:

key (string) Key.
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 /payrollPT/singleReportMappings/{key}/singleReportMappingDetails/{lineId}/singleReportMappingCode

PUT Set SourceId SingleReportMappingDetail

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

The following elements are required:

key (string) Key.
lineId (string) The detail identifier.
value (Guid) 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 /payrollPT/singleReportMappings/{key}/singleReportMappingDetails/{lineId}/sourceId

PUT Set SourceName SingleReportMappingDetail

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

The following elements are required:

key (string) Key.
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 /payrollPT/singleReportMappings/{key}/singleReportMappingDetails/{lineId}/sourceName

PUT Set SourceSchemaEntity SingleReportMapping

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

The following elements are required:

key (string) Key.
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 /payrollPT/singleReportMappings/{key}/sourceSchemaEntity

PUT Set SourceSchemaEntity SingleReportMappingDetail

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

The following elements are required:

key (string) Key.
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 /payrollPT/singleReportMappings/{key}/singleReportMappingDetails/{lineId}/sourceSchemaEntity

DELETE Operations

DELETE Single Report Mapping Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

key (string) Key.
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 /payrollPT/singleReportMappings/{key}/singleReportMappingDetails/{lineId}

DELETE SingleReportMapping 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 /payrollPT/singleReportMappings/{id}

DELETE SingleReportMapping by key

Deletes the entity record that matches the specified key.

The following elements are required:

key (string) Key.

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 /payrollPT/singleReportMappings/{key}

Resources


ApiSingleReportMappingResource

The following elements are required:

key (string) Key.
sourceSchemaEntity (string) Source Schema Entity.

The following elements are optional:

name (string) Name.
singleReportMappingDetails (List of ApiSingleReportMappingSingleReportMappingDetailsResource) Single Report Mapping Details.
See ApiSingleReportMappingSingleReportMappingDetailsResource.


ApiSingleReportMappingSingleReportMappingDetailsResource

The following elements are required:

sourceSchemaEntity (string) The schema entity id that originated the log creation.

The following elements are optional:

sourceId (Guid) The entity id that originated the log creation.
sourceName (string) Source.
singleReportMappingCode (string) Single Report Mapping.


SingleReportMappingDetailResource

The following elements are required:

sourceSchemaEntity (string) The schema entity id that originated the log creation.

The following elements are optional:

sourceId (Guid) The entity id that originated the log creation.
sourceName (string) Source.
singleReportMappingCode (string) Single Report Mapping.


SingleReportMappingResource

The following elements are required:

key (string) Key.
sourceSchemaEntity (string) Source Schema Entity.
(fk) Allowed value: the natural key of a record of type SchemaEntity.

The following elements are optional:

name (string) Name.
singleReportMappingDetails (List of SingleReportMappingDetailResource) Single Report Mapping Details.
See SingleReportMappingDetailResource.