ROSEPEOPLE Developers - Web API Reference

Contract Management | Benefit Account Model

Service to manage entities of type 'BenefitAccountModel'.

Overview


URL api/{tenantKey}/{orgKey}/contractManagement/benefitAccountModels
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET BenefitAccountModels

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /contractManagement/benefitAccountModels

GET BenefitAccountModels (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 BenefitAccountModelResource.

Response status codes:

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

Resource URL:

GET /contractManagement/benefitAccountModels?page={page}&pageSize={pageSize}

GET BenefitAccountModel 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 BenefitAccountModelResource.

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

GET BenefitAccountModel by key

Returns the entity record that matches the specified key.

The following elements are required:

benefitAccountModelKey (string) Benefit Account Model.

Response:

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

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 /contractManagement/benefitAccountModels/{benefitAccountModelKey}

GET Print BenefitAccountModel 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 /contractManagement/benefitAccountModels/{id}/print?template={template}

GET Print BenefitAccountModel by key

Prints the specified entity record.

The following elements are required:

benefitAccountModelKey (string) Benefit Account Model.

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 /contractManagement/benefitAccountModels/{benefitAccountModelKey}/print

GET Original Print BenefitAccountModelOriginal 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 /contractManagement/benefitAccountModels/{id}/printOriginal?template={template}

GET Original Print BenefitAccountModel by key

Prints the specified entity record.

The following elements are required:

benefitAccountModelKey (string) Benefit Account Model.

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 /contractManagement/benefitAccountModels/{benefitAccountModelKey}/printOriginal

POST Operations

POST BenefitAccountModels

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /contractManagement/benefitAccountModels

POST Benefit Account Model

Inserts a new 'Benefit Account Model Detail' in the 'Benefit Account Model'.

The following elements are required:

benefitAccountModelKey (string) Benefit Account Model.
value (ApiBenefitAccountModelBenefitAccountModelDetailsResource) The ApiBenefitAccountModelBenefitAccountModelDetailsResource instance.
See ApiBenefitAccountModelBenefitAccountModelDetailsResource.

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 /contractManagement/benefitAccountModels/{benefitAccountModelKey}/benefitAccountModelDetails

PUT Operations

PUT Set BenefitAccountModelKey BenefitAccountModel

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

The following elements are required:

benefitAccountModelKey (string) Benefit Account Model.
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 /contractManagement/benefitAccountModels/{benefitAccountModelKey}/benefitAccountModelKey

PUT Set BenefitAccountType BenefitAccountModelDetail

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

The following elements are required:

benefitAccountModelKey (string) Benefit Account Model.
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 /contractManagement/benefitAccountModels/{benefitAccountModelKey}/benefitAccountModelDetails/{lineId}/benefitAccountType

PUT Set IsActive BenefitAccountModel

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

The following elements are required:

benefitAccountModelKey (string) Benefit Account Model.
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 /contractManagement/benefitAccountModels/{benefitAccountModelKey}/isActive

PUT Set Name BenefitAccountModel

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

The following elements are required:

benefitAccountModelKey (string) Benefit Account Model.
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 /contractManagement/benefitAccountModels/{benefitAccountModelKey}/name

PUT Set Timing BenefitAccountModelDetail

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

The following elements are required:

benefitAccountModelKey (string) Benefit Account Model.
lineId (string) The detail identifier.
value (enum CustomTiming) The request body should contain the new value for the attribute.
See CustomTiming.

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 /contractManagement/benefitAccountModels/{benefitAccountModelKey}/benefitAccountModelDetails/{lineId}/timing

DELETE Operations

DELETE Benefit Account Model Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

benefitAccountModelKey (string) Benefit Account Model.
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 /contractManagement/benefitAccountModels/{benefitAccountModelKey}/benefitAccountModelDetails/{lineId}

DELETE BenefitAccountModel 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 /contractManagement/benefitAccountModels/{id}

DELETE BenefitAccountModel by key

Deletes the entity record that matches the specified key.

The following elements are required:

benefitAccountModelKey (string) Benefit Account Model.

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 /contractManagement/benefitAccountModels/{benefitAccountModelKey}

Resources


ApiBenefitAccountModelBenefitAccountModelDetailsResource

The following elements are required:

benefitAccountType (string) Benefit Account Type.

The following elements are optional:

timing (enum CustomTiming) Timing.
See CustomTiming.


ApiBenefitAccountModelResource

The following elements are required:

benefitAccountModelKey (string) Benefit Account Model.
name (string) Name.

The following elements are optional:

benefitAccountModelDetails (List of ApiBenefitAccountModelBenefitAccountModelDetailsResource) Benefit Account Model Details.
See ApiBenefitAccountModelBenefitAccountModelDetailsResource.


BenefitAccountModelDetailResource

The following elements are required:

benefitAccountType (string) Benefit Account Type.

The following elements are optional:

timing (enum CustomTiming) Timing.
See CustomTiming.


BenefitAccountModelResource

The following elements are required:

benefitAccountModelKey (string) Benefit Account Model.
name (string) Name.

The following elements are optional:

benefitAccountModelDetails (List of BenefitAccountModelDetailResource) Benefit Account Model Details.
See BenefitAccountModelDetailResource.


Enumerations


CustomTiming

1 Advance
2 Regular
3 Posterior
4 Inherited