Dependents

Create Dependent

Create a new dependent record with associated coverages and accumulators.

The dependent data is specified in the body of the request. The data is a JSON object conforming to the DI file specification for dependents, coverages, and accumulators accordingly.  All field names must be lowercase.

If there is an existing data match for the new dependent 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/dependent?memberid=[memberid]&groupnumber=[groupnumber]

{
    "depmemberid": "",
    "groupnumber": "",
    "groupname": "",
    "seqnumber": "",
    "salary": "",
    "coverages":
    [
        {
            "covtypename": "",
            "covtypedesc": "",
            "coveffdate": "",
            "covtermdate": "",
            "covvolume": ""
        }
    ],
    "accumulators": 
    [
        {
            "accum_name": "",
            "accum_desc": "",
            "coveragetype": "",
            "specifictype": "",
            "currentamount": "",
            "maximumamount": "",
            "innetwork": "",
            "individualaccum": "",
            "daterange": ""
        }
    ]
}

Sample Response Format


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

Update Dependent
Update a dependent record with associated coverages and accumulators.  
This is a sparse update; only fields being changed need to be included.  
The lookup keys for the dependent record to update are included in the query parameters, memberid, groupnumber, and depmemberid.
Any child records being updated (coverages, accumulators) must include a "record_action" field with the action being taken on them (n - new, m - modify, d - delete).
Child records must also include the appropriate necessary keys.
Sample Request Format
Required key fields are highlighted.
PATCH [base URL]/eligibility/dependent?memberid=[memberid]&groupnumber=[groupnumber]&depmemberid=[depmemberid]
{
    "groupnumber": "",
    "groupname": "",
    "seqnumber": "",
    "salary": "",
    "coverages":
    [
        {
            "record_action": "n",
            "covtypename": "",
            "covtypedesc": "",
            "coveffdate": "",
            "covtermdate": "",
            "covvolume": ""
        }
    ],
    "accumulators": 
    [
        {
            "record_action": "m",
            "accum_name": "",
            "accum_desc": "",
            "coveragetype": "",
            "specifictype": "",
            "currentamount": "",
            "maximumamount": "",
            "innetwork": "",
            "individualaccum": "",
            "daterange": ""
        }
    ]
}



Sample Response Format

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

Delete Dependent
Delete a dependent record and all associated child records (coverages, accumulators, etc).
The lookup keys for the dependent record to update are included in the query parameters, memberid, groupnumber, and depmemberid.
Sample Request Format

DELETE [base URL]/eligibility/dependent?memberid=[memberid]&groupnumber=[groupnumber]&depmemberid=[depmemberid]

Sample Response Format

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