COBRA Eligible
Home > Resources > COBRA
The COBRA API allows users to retrieve COBRA eligible employees. The API will return:
- A new hire who has elected a COBRA eligible benefit plan
- An existing employee or dependent who has opted out of coverage from a COBRA eligible benefit plan. The employee or dependent must have been previously active in the given plan.
https://serverurl/path/v1.1/cobra
.
| Example Request | |
| GET | https://serverurl/api/v1.1/cobra?from=1/1/12 |
| Request Content |
Required Parameter for this API:
Optional parameters for this API:
|
| Return Value |
| Http header "Accept" value -- "text/xml" or "application/xml" will return XML, otherwise JSON will be returned. |
| XML | <cobra xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <enrollment> <enrollee> <employeeUid>54</employeeUid> <employeeId>10403</employeeId> <firstName>Gregory</firstName> <lastName>Anderson</lastName> <middleName>Jackson</middleName> <ssn>432-09-5850</ssn> <dob>1970-12-15T00:00:00</dob> <disabled xsi:nil="true" /> <contact> <country>USA</country> <address1>3699 McKinney Ave</address1> <address2 /> <city>Dallas</city> <state>TX</state> <zip>75204</zip> <home_phone>(214) 284-1348</home_phone> <work_phone>(469) 540-1578</work_phone> <email>HRTestEmpWork@ascentis.com</email> </contact> </enrollee> <benefits> <benefit> <planId>29</planId> <planName>Aetna Medical PPO</planName> <startDate>2009-02-01T00:00:00</startDate> <endDate>2012-01-11T00:00:00</endDate> <employeeMonthlyContribution>180.0000</employeeMonthlyContribution> <contributionFrequency>26</contributionFrequency> <percentage>false</percentage> <changeReasonId>240</changeReasonId> <changeReason>Other</changeReason> </benefit> </benefits> <changes> <change> <changeId>476</changeId> <recordType>Enrollment</recordType> <uid>54</uid> <auditKey1>29</auditKey1> <auditKey2>4</auditKey2> <action>Any</action> <timestamp>2012-01-11T12:16:13.757</timestamp> <modifiedBy>haroldl</modifiedBy> <items> <item> <itemId>1398</itemId> <field>StartDate</field> <oldValue>02-01-2009</oldValue> <newValue>02-01-2009</newValue> </item> <item> <itemId>1399</itemId> <field>StopDate</field> <newValue>01-11-2012</newValue> </item> <item> <itemId>1400</itemId> <field>AmtPctFlg</field> <oldValue /> <newValue /> </item> </items> </change> </changes> <dependents> <dependent> <enrollee> <employeeUid>54</employeeUid> <employeeId>10403</employeeId> <firstName>Gregory</firstName> <lastName>Anderson</lastName> <middleName>Jackson</middleName> <ssn>432-09-5850</ssn> <dob>2000-01-01T00:00:00</dob> <disabled>true</disabled> <contact> <country>USA</country> <address1>3699 McKinney Ave</address1> <address2 /> <city>Dallas</city> <state>TX</state> <zip>75204</zip> <home_phone>(214) 284-1348</home_phone> <work_phone>(469) 540-1578</work_phone> <email>HRTestEmpWork@ascentis.com</email> </contact> </enrollee> <benefits> <benefit> <planId>29</planId> <planName>Aetna Medical PPO</planName> <startDate>2009-02-01T00:00:00</startDate> <endDate>2012-01-11T00:00:00</endDate> <employeeMonthlyContribution>180.0000</employeeMonthlyContribution> <contributionFrequency>26</contributionFrequency> <percentage>false</percentage> <changeReasonId>240</changeReasonId> <changeReason>Other</changeReason> </benefit> </benefits> <changes> <change> <changeId>476</changeId> <recordType>Enrollment</recordType> <uid>54</uid> <auditKey1>29</auditKey1> <auditKey2>4</auditKey2> <action>Any</action> <timestamp>2012-01-11T12:16:13.757</timestamp> <modifiedBy>haroldl</modifiedBy> <items> <item> <itemId>1398</itemId> <field>StartDate</field> <oldValue>02-01-2009</oldValue> <newValue>02-01-2009</newValue> </item> <item> <itemId>1399</itemId> <field>StopDate</field> <newValue>01-11-2012</newValue> </item> <item> <itemId>1400</itemId> <field>AmtPctFlg</field> <oldValue /> <newValue /> </item> </items> </change> </changes> </dependent> </dependents> </enrollment> </cobra> |
| JSON |
{ "enrollments": [ { "enrollee": { "employeeUid": 54, "employeeId": "10403", "firstName": "Gregory", "lastName": "Anderson", "middleName": "Jackson", "ssn": "432-09-5850", "dob": "2000-02-01", "contact": { "country": "USA", "address1": "3699 McKinney Ave", "address2": "", "city": "Dallas", "state": "TX", "zip": "75204", "home_phone": "(214) 284-1348", "work_phone": "(469) 540-1578", "email": "HRTestEmpWork@ascentis.com" } }, "benefits": [ { "planId": 29, "planName": "Aetna Medical PPO", "startDate": "2009-02-01T00:00:00", "endDate": "2012-01-11T00:00:00", "employeeMonthlyContribution": 180, "contributionFrequency": 26, "percentage": false, "changeReasonId": 240, "changeReason": "Other" } ], "changes": [ { "changeId": 476, "recordType": "Enrollment", "uid": 54, "auditKey1": "29", "auditKey2": "4", "action": "Any", "timestamp": "2012-01-11T12:16:13.757", "modifiedBy": "haroldl", "items": [ { "itemId": 1398, "field": "StartDate", "oldValue": "02-01-2009", "newValue": "02-01-2009" }, { "itemId": 1399, "field": "StopDate", "newValue": "01-11-2012" }, { "itemId": 1400, "field": "AmtPctFlg", "oldValue": "", "newValue": "" } ] } ], "dependents": [ { "enrollee": { "employeeUid": 54, "firstName": "Gregory", "lastName": "Anderson", "middleName": "Jackson", "ssn": "432-09-5850", "dob": "2000-02-01", "disabled": "true", "contact": { "country": "USA", "address1": "3699 McKinney Ave", "address2": "", "city": "Dallas", "state": "TX", "zip": "75204", "home_phone": "(214) 284-1348", "work_phone": "(469) 540-1578", "email": "HRTestEmpWork@ascentis.com" } }, "benefits": [ { "planId": 29, "planName": "Aetna Medical PPO", "startDate": "2009-02-01T00:00:00", "endDate": "2012-01-11T00:00:00", "employeeMonthlyContribution": 180, "contributionFrequency": 26, "percentage": false, "changeReasonId": 240, "changeReason": "Other" } ], "changes": [ { "changeId": 476, "recordType": "Enrollment", "uid": 54, "auditKey1": "29", "auditKey2": "4", "action": "Any", "timestamp": "2012-01-11T12:16:13.757", "modifiedBy": "haroldl", "items": [ { "itemId": 1398, "field": "StartDate", "oldValue": "02-01-2009", "newValue": "02-01-2009" }, { "itemId": 1399, "field": "StopDate", "newValue": "01-11-2012" }, { "itemId": 1400, "field": "AmtPctFlg", "oldValue": "", "newValue": "" } ] } ] } ] } ] } |
| |
| Resource Information | |
| Requires Authentication? | Yes |
| Response Formats | json xml |
| HTTP Methods | GET |
| Request Content | N/A |
| Return Code | 200: Response Completed 403: Incorrect Authorization 400: Bad Data 404: No changes exist |
| API Version | v1.1 only |
