ROSEPEOPLE Developers - Web API Reference

People | Debt Procedure Account Type

Service to manage entities of type 'DebtProcedureAccountType'.

Overview


URL api/{tenantKey}/{orgKey}/peopleCore/debtProcedureAccountTypes
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 DebtProcedureAccountTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /peopleCore/debtProcedureAccountTypes

GET DebtProcedureAccountTypes (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 DebtProcedureAccountTypeResource.

Response status codes:

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

Resource URL:

GET /peopleCore/debtProcedureAccountTypes?page={page}&pageSize={pageSize}

GET DebtProcedureAccountType 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 DebtProcedureAccountTypeResource.

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

GET DebtProcedureAccountType by key

Returns the entity record that matches the specified key.

The following elements are required:

debtProcedureAccountTypeKey (string) Debt Procedure Account Type.

Response:

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

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 /peopleCore/debtProcedureAccountTypes/{debtProcedureAccountTypeKey}

GET Print DebtProcedureAccountType 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 /peopleCore/debtProcedureAccountTypes/{id}/print?template={template}

GET Print DebtProcedureAccountType by key

Prints the specified entity record.

The following elements are required:

debtProcedureAccountTypeKey (string) Debt Procedure Account Type.

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 /peopleCore/debtProcedureAccountTypes/{debtProcedureAccountTypeKey}/print

GET Original Print DebtProcedureAccountTypeOriginal 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 /peopleCore/debtProcedureAccountTypes/{id}/printOriginal?template={template}

GET Original Print DebtProcedureAccountType by key

Prints the specified entity record.

The following elements are required:

debtProcedureAccountTypeKey (string) Debt Procedure Account Type.

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 /peopleCore/debtProcedureAccountTypes/{debtProcedureAccountTypeKey}/printOriginal

POST Operations

POST DebtProcedureAccountTypes

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /peopleCore/debtProcedureAccountTypes

PUT Operations

PUT Set DebtProcedureAccountTypeKey DebtProcedureAccountType

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

The following elements are required:

debtProcedureAccountTypeKey (string) Debt Procedure Account Type.
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 /peopleCore/debtProcedureAccountTypes/{debtProcedureAccountTypeKey}/debtProcedureAccountTypeKey

PUT Set Description DebtProcedureAccountType

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

The following elements are required:

debtProcedureAccountTypeKey (string) Debt Procedure Account Type.
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 /peopleCore/debtProcedureAccountTypes/{debtProcedureAccountTypeKey}/description

PUT Set IsActive DebtProcedureAccountType

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

The following elements are required:

debtProcedureAccountTypeKey (string) Debt Procedure Account Type.
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 /peopleCore/debtProcedureAccountTypes/{debtProcedureAccountTypeKey}/isActive

DELETE Operations

DELETE DebtProcedureAccountType 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 /peopleCore/debtProcedureAccountTypes/{id}

DELETE DebtProcedureAccountType by key

Deletes the entity record that matches the specified key.

The following elements are required:

debtProcedureAccountTypeKey (string) Debt Procedure Account Type.

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 /peopleCore/debtProcedureAccountTypes/{debtProcedureAccountTypeKey}

Resources


ApiDebtProcedureAccountTypeResource

The following elements are required:

debtProcedureAccountTypeKey (string) Debt Procedure Account Type.
description (string) Description.


DebtProcedureAccountTypeResource

The following elements are required:

debtProcedureAccountTypeKey (string) Debt Procedure Account Type.
description (string) Description.