Build Draft Provider Pricing Clauses Across Worksheets

Building draft provider pricing clauses across pricing worksheets is a long-running operation that can be initiated by an HTTP POST request to http://[hostName]:[portNumber]/[api-context-root]/builddraftproviderpricingclauses. For more information about long-running operations, see Long-Running Operations Through REST.

Use this integration point to build selected draft provider pricing clauses that can belong to different pricing worksheets. For build operations in the context of a single pricing worksheet, use Build.

Clients must send one or more draft provider pricing clauses in the POST payload. Each list item must specify both the pricing worksheet code and the draft provider pricing clause code. If the client does not include a list of draft provider pricing clauses, the system returns an error message.

{
  "draftProviderPricingClauseList": [
    {"worksheet": "WS001", "code": "DPPC001"},
    {"worksheet": "WS002", "code": "DPPC002"}
  ]
}

A single request can include a maximum of 1000 draft provider pricing clauses. If the request exceeds this limit, the system returns the error message A maximum of 1000 draft provider pricing clauses can be built in a single request.

If a draft provider pricing clause with the specified code is not found in the context of the pricing worksheet, the system creates the interface message Draft provider pricing clause with {code} not found for each such code.

If the specified worksheet for a draft provider pricing clause with the specified code is not found, the system creates the interface message Worksheet with {code} not found for each such code.

Before creating the long-running operation task, the system checks access for all pricing worksheets in the request. If the user does not have the required access to one or more pricing worksheets, the system returns an OHI-ACRE-006 access error for each inaccessible pricing worksheet. No worksheet task or operation batch is created when an access error exists.

This integration point validates and builds draft provider pricing clauses. The build process (re-)validates each draft provider pricing clause in context before creating a provider pricing clause for it, including those that already have the status Valid. This validation is identical to the validation in the Validate Draft Provider Pricing Clauses operation.

For details about the build function, see Build Draft Provider Pricing Clauses.

The continue_when_invalid request header parameter determines whether the system stops the build operation when it finds an invalid draft provider pricing clause or continues with building valid draft provider pricing clauses into provider pricing clauses. When set to true, the operation continues. When set to false, the operation stops processing only the worksheet that contains the invalid draft provider pricing clause. Processing can continue for the other worksheets in the same request.

Response Messages

Success

The system responds with 201 Created. The system also returns a link to the task resource in the Location header:
Location: http://[hostName]:[portNumber]/[api-context-root]/claims/generic/task/{id} This enables the external system to track progress by issuing a GET request to this task URI.

Failure

The following HTTP status codes can be returned:

Table 1. Failure

Response	Description
HTTP 401	Unauthorized
HTTP 403	The user does not have the required access to one or more pricing worksheets in the request

For more details, see Response Messages.

Authorization

The pricingworksheets.build IP access restriction protects this integration point. A grant must be given with both the Read and Update flag set.