Meta Endpoints
PlanSource offers four meta endpoints to retrieve every value for all list validated fields. This means that if a developer were to make a GET call to the /subscriber/meta endpoint, they would receive all available values for marital status, gender, division, etc. This call is useful when a developer needs to POST or PUT some information into a list validated field but doesn't know all of the available options for said field.
List Validated Fields
To learn more about List Validated Fields, click here!
Below are the four meta endpoints for subscriber, dependent, beneficiaries, and coverage. Under each endpoint are the most common list validated fields that PlanSource has to offer.
GET /subscriber/meta
To see a full list of subscriber data fields, visit Subscriber Data Fields.
| Field Names |
|---|
| is_smoker |
| division |
| org_class |
| location |
| employment_level |
| union_code |
| state |
| country |
| gender |
| marital_status |
| org_payroll_id |
| termination_reason |
{
"status": "success",
"errors": [],
"data": {
"is_smoker": {
"update": true,
"required": false,
"caption": "Tobacco User",
"data_type": "STRING",
"validation_data": [
[
"YES",
"YES"
],
[
"NO",
"NO"
]
]
},
"division": {
"update": true,
"required": false,
"caption": "Division",
"data_type": "STRING",
"validation_data": [
[
"A",
"A"
],
[
"B",
"B"
],
[
"C",
"C"
]
]
},
"org_class": {
"update": true,
"required": false,
"caption": "Class",
"data_type": "STRING",
"validation_data": [
[
"HOURLY",
"HOURLY"
],
[
"SALARY",
"SALARY"
]
]
},
"location": {
"update": true,
"required": false,
"caption": "Location",
"data_type": "STRING",
"validation_data": [
[
"FLORIDA",
"FLORIDA"
],
[
"UTAH",
"UTAH"
]
]
},
"employment_level": {
"update": true,
"required": false,
"caption": "Employment Level",
"data_type": "STRING",
"validation_data": [
[
"F",
"F"
],
[
"P",
"P"
]
]
},
"union_code": {
"update": true,
"required": false,
"caption": "Union",
"data_type": "STRING",
"validation_data": [
[
"HR",
"HR"
],
[
"PRODUCT",
"PRODUCT"
],
... //redacted data to keep code sample small
[
"IT",
"IT"
]
]
},
"state": {
"update": true,
"required": false,
"caption": "State/Province",
"data_type": "STRING",
"validation_data": [
[
"APO Europe",
"AE"
],
[
"Alabama",
"AL"
],
... //redacted data to keep code sample small
[
"Wyoming",
"WY"
]
]
},
"country": {
"update": true,
"required": false,
"caption": "Country",
"data_type": "STRING",
"validation_data": [
[
"Afghanistan",
"Afghanistan"
],
[
"Aland Islands",
"Aland Islands"
],
... //redacted data to keep code sample small
[
"Zimbabwe",
"Zimbabwe"
]
]
},
"gender": {
"update": true,
"required": false,
"caption": "Gender",
"data_type": "STRING",
"validation_data": [
[
"Male",
"M"
],
[
"Female",
"F"
]
]
},
"marital_status": {
"update": true,
"required": false,
"caption": "Marital Status",
"data_type": "STRING",
"validation_data": [
[
"Married",
"M"
],
[
"Single",
"S"
],
[
"Unreported",
"U"
]
]
},
"org_payroll_id": {
"update": true,
"required": false,
"caption": "Payroll Schedule",
"data_type": "NUMBER",
"validation_data": [
[
"Biweekly (26 per year)",
563
]
]
},
"termination_reason": {
"update": true,
"required": false,
"caption": "Termination Reason",
"data_type": "STRING",
"validation_data": [
{
"lookup_code": "employment_termination",
"name": "Termination of Employment (COBRA)",
"description": "Employment is terminated (voluntarily or involuntarily) in a manner that does not make the employee ineligible for COBRA (if applicable)."
},
{
"lookup_code": "employment_termination_for_cause",
"name": "Termination or Employment for gross misconduct (Non-COBRA)",
"description": "Termination of Employment for gross misconduct (Non-COBRA)"
},
... //redacted data to keep code sample small
{
"lookup_code": "loa_subscriber_termination",
"name": "Termed due to LOA (COBRA)",
"description": "Termed due to LOA (COBRA)"
}
]
}
}
}
GET /dependent/meta
To see a full list of dependent data fields, visit Dependent Data Fields.
| Field Names |
|---|
| hide_dependent_on_termination |
| gender |
| relationship_code |
| state |
| country |
| is_smoker |
| termination_reason |
{
"status": "success",
"errors": [],
"data": {
"hide_dependent_on_termination": {
"update": true,
"required": false,
"caption": "Hide dependent on termination",
"data_type": "BOOLEAN",
"validation_data": [
[
"F",
"F"
],
[
"P",
"P"
]
]
},
"gender": {
"update": true,
"required": true,
"caption": "Gender",
"data_type": "STRING",
"validation_data": [
[
"Male",
"M"
],
[
"Female",
"F"
]
]
},
"relationship_code": {
"update": true,
"required": true,
"caption": "Relationship",
"data_type": "STRING",
"validation_data": [
[
"Spouse",
"spouse"
],
[
"Child",
"child"
],
... //redacted data to keep code sample small
[
"Child Age 26 to 30",
"chile_age_26_to_30"
]
]
},
"state": {
"update": true,
"required": false,
"caption": "State",
"data_type": "STRING",
"validation_data": [
[
"APO Europe",
"AE"
],
[
"Alabama",
"AL"
],
... //redacted data to keep code sample small
[
"Wyoming",
"WY"
]
]
},
"country": {
"update": true,
"required": false,
"caption": "Country",
"data_type": "STRING",
"validation_data": [
[
"Afghanistan",
"Afghanistan"
],
[
"Aland Islands",
"Aland Islands"
],
... //redacted data to keep code sample small
[
"Zimbabwe",
"Zimbabwe"
]
]
},
"is_smoker": {
"update": true,
"required": false,
"caption": "Tobacco User",
"data_type": "STRING",
"validation_data": [
[
"YES",
"YES"
],
[
"NO",
"NO"
]
]
},
"termination_reason": {
"update": true,
"required": false,
"caption": "Termination Reason",
"data_type": "NUMBER",
"validation_data": [
{
"lookup_code": "divorce",
"name": "Divorce (COBRA)",
"description": "Spouse Divorced from employee"
},
{
"lookup_code": "overage_child",
"name": "Child becomes ineligible (COBRA)",
"description": "Child ineligibile for coverage due to age"
},
{
"lookup_code": "dependent_death",
"name": "Dependent Death (Non-COBRA)",
"description": "Dependent death."
}
]
}
}
}
GET /beneficiaries/meta
To see a full list of beneficiary data fields, visit Beneficiary Data Fields.
| Field Names |
|---|
| relationship |
| allocation |
| primary_beneficiary |
| termination_reason |
{
"status": "success",
"errors": [],
"data": {
"relationship": {
"update": true,
"required": true,
"caption": "Relationship",
"data_type": "STRING",
"validation_data": [
[
"SPOUSE",
"SPOUSE"
],
[
"CHILD",
"CHILD"
]
]
},
"allocation": {
"update": true,
"required": true,
"caption": "Allocation",
"data_type": "NUMBER",
"validation_data": [
[
"25%",
"25%"
],
[
"50%",
"50%"
],
[
"100%",
"100%"
]
]
},
"primary_beneficiary": {
"update": true,
"required": true,
"caption": "Primary Beneficiary",
"data_type": "BOOLEAN",
"validation_data": [
[
"YES",
"YES"
],
[
"NO",
"NO"
]
]
},
"termination_reason": {
"update": true,
"required": false,
"caption": "Termination Reason",
"data_type": "STRING",
"validation_data": [
{
"lookup_code": "death",
"name": "Death (COBRA)",
"description": "Death of Employee"
},
{
"lookup_code": "voluntary_waive",
"name": "Voluntary Coverage Waive (Non-COBRA)",
"description": "Subscriber voluntarily waived coverage"
},
... //redacted data to keep code sample small
{
"lookup_code": "other",
"name": "Other (Non-COBRA)",
"description": "Other"
}
]
}
}
}
GET /coverage/meta
To see a full list of coverage data fields, visit Coverage Data Fields.
| Field Names |
|---|
| termination_reasons |
{
"status": "success",
"errors": [],
"data": {
"termination_reasons": [
{
"id": 1,
"name": "Termination of Employment (COBRA)",
"lookup_code": "employment_termination"
},
{
"id": 2,
"name": "Termination or Employment for gross misconduct (Non-COBRA)",
"lookup_code": "employment_termination_for_cause"
},
... //redacted data to keep code sample small
{
"id": 25,
"name": "Failed to receive documentation (Non-COBRA)",
"lookup_code": "failed_to_receive_documentation"
}
]
}
}
Updated about 5 years ago