Coverages

Create Coverage

Create a new coverage record.

The coverage data is specified in the body of the request. The data is a JSON object conforming to the DI file specification for coverages.  All field names must be lowercase.

If there is an existing data match for the new coverage record, the record is not created. When the call is accepted it returns an operations URL that the requesting client uses to track the status of the request.

The lookup keys for the eligibility record to update are included in the query parameters, memberid and groupnumber.

Sample Request Format

Required key fields are highlighted.
POST [base URL]/eligibility/coverage?memberid=[memberid]&groupnumber=[groupnumber]

{
    "covtypename": "",
    "covtypedesc": "",
    "coveffdate": "",
    "covtermdate": "",
    "covvolume": ""
}

Sample Response Format


HTTP/1.1 202 Accepted
Operation-Location: [base URL]/operation/[operationId]
 

Update Coverage
Update a coverage record.  
This is a sparse update; only fields being changed need to be included.  
The lookup keys for the coverage record to update are included in the query parameters, memberid, groupnumber, covtypename, and coveffdate.
Sample Request Format

PATCH [base URL]/eligibility/coverage?memberid=[memberid]&groupnumber=[groupnumber]&covtypename=[covtypename]&coveffdate=[coveffdate]
{
    "covtypedesc": "",
    "covtermdate": "",
    "covvolume": ""
}
Sample Response Format

HTTP/1.1 202 Accepted
Operation-Location: [base URL]/operation/[operationId]

Delete Coverage
Delete a coverage record.
The lookup keys for the coverage record to update are included in the query parameters, memberid, groupnumber, covtypename, and coveffdate.
Sample Request Format

DELETE [base URL]/eligibility/coverage?memberid=[memberid]&groupnumber=[groupnumber]&covtypename=[covtypename]&coveffdate=[coveffdate]
Sample Response Format

HTTP/1.1 202 Accepted
Operation-Location: [base URL]/operation/[operationId]
Comments