PlanSource API

The PlanSource API Developer Hub

Welcome to the PlanSource API developer hub. You'll find comprehensive guides and documentation to help you start working with PlanSource API as quickly as possible, as well as support if you get stuck. Let us help you jump right in!

Demographic

 

/subscriber

Create a subscriber resource.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
posthttps://partner-dev-api.plansource.com/admin/v2/subscriber
curl --request POST \
  --url https://partner-dev-api.plansource.com/admin/v2/subscriber
var request = require("request");

var options = { method: 'POST',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscriber' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscriber")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://partner-dev-api.plansource.com/admin/v2/subscriber");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscriber"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12186626",
      "rel": "self"
    },
    "id": 12186626,
    "subscriber_code": null,
    "first_name": "John",
    "last_name": "Test",
    "middle_name": "M",
    "address_1": "1234TestSt.",
    "address_2": "",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "32801",
    "country": "United States",
    "home_phone": "4071231234",
    "work_phone": "4071231234",
    "cell_phone": "4071231234",
    "gender": "M",
    "hire_date": "2006/06/13",
    "birthdate": "1990/03/11",
    "ssn": null,
    "original_effective_date": null,
    "change_effective_date": null,
    "termination_date": null,
    "union_code": "HR",
    "employment_level": null,
    "pay_rate": "40.0",
    "pay_type": null,
    "org_payroll_id": "563",
    "employee_number": "2",
    "public_id": 988618,
    "marital_status": "M",
    "division": "A",
    "location": "FLORIDA",
    "org_class": "HOURLY",
    "business_title": "MR",
    "udef_1": null,
    "udef_2": null,
    "udef_3": null,
    "udef_4": null,
    "udef_5": null,
    "udef_6": null,
    "udef_7": null,
    "udef_8": null,
    "udef_9": null,
    "udef_10": null,
    "udef_11": null,
    "udef_12": null,
    "udef_13": null,
    "udef_14": null,
    "udef_15": null,
    "udef_16": null,
    "udef_17": null,
    "udef_18": null,
    "udef_19": null,
    "udef_20": null,
    "ee_code": null,
    "benefit_company": null,
    "original_hire_date": "2006/06/13",
    "seniority_date": null,
    "employment_status": null,
    "employment_status_starts_on": null,
    "employment_status_ends_on": null,
    "employee_type": null,
    "current_salary_effective_on": "2006/06/13",
    "current_salary": "70000.0",
    "benefit_deduction_group": null,
    "highly_compensated": null,
    "vip": null,
    "fmla": null,
    "name_suffix": null,
    "subscriber_status_id": 15,
    "status_changed_at": "2006/06/1300: 00: 00-0400",
    "status_starts_on": "2006/06/13",
    "status_ends_on": null,
    "benefits_start_date": "2006/06/13",
    "benefits_end_date": null,
    "parent_dependent_id": null,
    "status_ends_on_expected": null,
    "subscriber_status_subtype_id": null,
    "org_admin_enroll_reason_id": null,
    "test_employee": false,
    "is_voluntary_termination": false,
    "hide_from_payroll": false,
    "termination_reason_id": null,
    "bank_account_type": null,
    "ssn_exported": false,
    "eligible_org_population_ids": null,
    "shareholder": false,
    "owner": false,
    "anthem_hcid": null,
    "anthem_member_code": null,
    "written_language": null,
    "spoken_language": null,
    "exclude_from_batch_import": false,
    "anthem_sub_id": null,
    "hours_per_week": null,
    "medicare_reason": null,
    "medicare_plan": null,
    "medicare_effective_date": null,
    "medicare_termination_date": null,
    "is_smoker": null,
    "anthem_emp_dept_code": null,
    "county": null,
    "udef_21": null,
    "udef_22": null,
    "udef_23": null,
    "udef_24": null,
    "udef_25": null,
    "udef_26": null,
    "udef_27": null,
    "udef_28": null,
    "udef_29": null,
    "udef_30": null,
    "is_aca_full_time_for_enrollment": null,
    "email": null,
    "user_name": "jtest_7",
    "email2": null,
    "locked_at": null,
    "attempted_logon_count": 0,
    "disabled_on": null,
    "preferred_locale": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "A user_name or first_name and last_name is required.",
    "details": null,
    "error_code": 400
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'ubscriber' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Query Params

is_custom_id
boolean

Set to true if the {id} in the path is customer generated.

Body Params

subscriber_code
string
first_name
string
last_name
string
middle_name
string
address_1
string
address_2
string
city
string
state
string

Valid values are based on what is retrieved from meta resource.

zip_code
string
country
string

Valid values are based on what is retrieved from meta resource.

home_phone
string
work_phone
string
cell_phone
string
gender
string

Valid values are based on what is retrieved from meta resource.

hire_date
string

YYYY-MM-DD date format.

birthdate
string

YYYY-MM-DD date format.

ssn
string
original_effective_date
string

YYYY-MM-DD date format.

change_effective_date
string

YYYY-MM-DD date format.

termination_date
string

YYYY-MM-DD date format.

union_code
string
employment_level
string

Valid values are based on what is retrieved from meta resource.

pay_rate
string
pay_type
string
org_payroll_id
string

Valid values are based on what is retrieved from meta resource.

employee_number
string
public_id
string
marital_status
string

Valid values are based on what is retrieved from meta resource.

division
string
location
string
org_class
string
business_title
string
udef_1
string
udef_2
string
udef_3
string
udef_4
string
udef_5
string
udef_6
string
udef_7
string
udef_8
string
udef_9
string
udef_10
string
udef_11
string
udef_12
string
udef_13
string
udef_14
string
udef_15
string
udef_16
string
udef_17
string
udef_18
string
udef_19
string
udef_20
string
ee_code
string
benefit_company
string
original_hire_date
string

YYYY-MM-DD date format.

seniority_date
string

YYYY-MM-DD date format.

employment_status
string
employment_status_starts_on
string
employment_status_ends_on
string
employee_type
string
current_salary_effective_on
string

YYYY-MM-DD date format.

current_salary
string
benefit_deduction_group
string
highly_compensated
boolean
vip
boolean
fmla
boolean
name_suffix
string
subscriber_status_id
string
status_changed_at
string

YYYY-MM-DD date format.

status_starts_on
string

YYYY-MM-DD date format.

status_ends_on
string

YYYY-MM-DD date format.

benefits_start_date
string

YYYY-MM-DD date format.

benefits_end_date
string

YYYY-MM-DD date format.

parent_dependent_id
string
status_ends_on_expected
string

YYYY-MM-DD date format.

subscriber_status_subtype_id
string
test_employee
boolean
is_voluntary_termination
boolean
hide_from_payroll
boolean
termination_reason_id
string
bank_account_type
string
ssn_exported
boolean
eligible_org_population_ids
string
shareholder
boolean
owner
boolean
anthem_hcid
string
anthem_member_code
string
written_language
string

Valid values are based on what is retrieved from meta resource.

spoken_language
string

Valid values are based on what is retrieved from meta resource.

exclude_from_batch_import
boolean
anthem_sub_id
string
hours_per_week
string
medicare_reason
string

Valid values are based on what is retrieved from meta resource.

medicare_plan
string

Valid values are based on what is retrieved from meta resource.

medicare_effective_date
string

YYYY-MM-DD date format.

medicare_termination_date
string

YYYY-MM-DD date format.

is_smoker
string

Valid values are based on what is retrieved from meta resource.

anthem_emp_dept_code
string

Valid values are based on what is retrieved from meta resource.

county
string
udef_21
string
udef_22
string
udef_23
string
udef_24
string
udef_25
string
udef_26
string
udef_27
string
udef_28
string
udef_29
string
udef_30
string
email
string
user_name
string
email2
string
locked_at
string
attempted_logon_count
string
disabled_on
string
preferred_locale
string

Response

Subscriber create response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
subscriber_codestring
first_namestring
last_namestring
middle_namestring
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
home_phonestring
work_phonestring
cell_phonestring
genderstring
hire_datestring
birthdatestring
ssnstring
original_effective_datestring
change_effective_datestring
termination_datestring
union_codestring
employment_levelstring
pay_ratestring
pay_typestring
org_payroll_idinteger
employee_numberstring
public_idinteger
marital_statusstring
divisionstring
locationstring
org_classstring
business_titlestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
udef_11string
udef_12string
udef_13string
udef_14string
udef_15string
udef_16string
udef_17string
udef_18string
udef_19string
udef_20string
ee_codestring
benefit_companystring
original_hire_datestring
seniority_datestring
employment_statusstring
employment_status_starts_onstring
employment_status_ends_onstring
employee_typestring
current_salary_effective_onstring
current_salarystring
benefit_deduction_groupstring
highly_compensatedstring
vipstring
fmlastring
name_suffixstring
subscriber_status_idstring
status_changed_atstring
status_starts_onstring
status_ends_onstring
benefits_start_datestring
benefits_end_datestring
parent_dependent_idstring
status_ends_on_expectedstring
subscriber_status_subtype_idstring
org_admin_enroll_reason_idstring
test_employeeboolean
is_voluntary_terminationstring
hide_from_payrollstring
termination_reason_idstring
bank_account_typestring
ssn_exportedboolean
eligible_org_population_idsstring
shareholderstring
ownerstring
anthem_hcidstring
anthem_member_codestring
written_languagestring
spoken_languagestring
exclude_from_batch_importstring
anthem_sub_idstring
hours_per_weekstring
medicare_reasonstring
medicare_planstring
medicare_effective_datestring
medicare_termination_datestring
is_smokerstring
anthem_emp_dept_codestring
countystring
udef_21string
udef_22string
udef_23string
udef_24string
udef_25string
udef_26string
udef_27string
udef_28string
udef_29string
udef_30string
is_aca_full_time_for_enrollmentstring
emailstring
user_namestring
email2string
locked_atstring
attemtped_logon_countinteger
disabled_onstring
preferred_localestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscriber/meta

Retrieve meta data for subscriber.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
gethttps://partner-dev-api.plansource.com/admin/v2/subscriber/meta
curl --request GET \
  --url https://partner-dev-api.plansource.com/admin/v2/subscriber/meta
var request = require("request");

var options = { method: 'GET',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscriber/meta' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscriber/meta")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://partner-dev-api.plansource.com/admin/v2/subscriber/meta");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscriber/meta"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "payroll_schedules": {
      "id": 119298,
      "name": "Monthly",
      "lookup_code": "monthly_1"
    },
    "is_smoker": {
      "update": true,
      "required": false,
      "caption": "Tobacco User",
      "data_type": "STRING",
      "validation_data": [
        "YES",
        "YES"
      ]
    },
    "employment_level": {
      "update": true,
      "required": false,
      "caption": "Employment Level",
      "data_type": "STRING",
      "validation_data": [
        "F",
        "F"
      ]
    },
    "state": {
      "update": true,
      "required": false,
      "caption": "State/Province",
      "data_type": "STRING",
      "validation_data": [
        "Alabama",
        "AL"
      ]
    },
    "country": {
      "update": true,
      "required": false,
      "caption": "Country",
      "data_type": "STRING",
      "validation_data": [
        "Lebanon",
        "Lebanon"
      ]
    },
    "gender": {
      "update": true,
      "required": false,
      "caption": "Gender",
      "data_type": "STRING",
      "validation_data": [
        "Male",
        "M"
      ]
    },
    "marital_status": {
      "update": true,
      "required": false,
      "caption": "Marital Status",
      "data_type": "STRING",
      "validation_data": [
        "Married",
        "M"
      ]
    },
    "org_payroll_id": {
      "update": true,
      "required": false,
      "caption": "Payroll Schedule",
      "data_type": "NUMBER",
      "validation_data": [
        "Monthly",
        119298
      ]
    },
    "termination_reason": {
      "update": true,
      "required": false,
      "caption": "Termination Reason",
      "data_type": "STRING",
      "validation_data": {
        "lookup_code": "death",
        "name": "Death (COBRA)",
        "description": "Death of Employee"
      }
    }
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "No employee with id: met found",
    "details": null,
    "error_code": 404
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Response

List of meta data for subscriber.

statusstring
errorsarray
dataarray
payroll_schedulesarray
idinteger
namestring
lookup_codestring
is_smokerarray
updateboolean
requiredboolean
captionstring
data_typestring
validation_dataarray
employment_levelarray
statearray
countryarray
genderarray
marital_statusarray
org_payroll_idarray
termination_reasonarray
descriptionstring

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscriber/{id}

Retrieve data for a subscriber.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
gethttps://partner-dev-api.plansource.com/admin/v2/subscriber/id
curl --request GET \
  --url https://partner-dev-api.plansource.com/admin/v2/subscriber/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscriber/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscriber/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://partner-dev-api.plansource.com/admin/v2/subscriber/id");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscriber/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12186626",
      "rel": "self"
    },
    "id": 12186626,
    "subscriber_code": null,
    "first_name": "John",
    "last_name": "Test",
    "middle_name": "M",
    "address_1": "1234TestSt.",
    "address_2": "",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "32801",
    "country": "United States",
    "home_phone": "4071231234",
    "work_phone": "4071231234",
    "cell_phone": "4071231234",
    "gender": "M",
    "hire_date": "2006/06/13",
    "birthdate": "1990/03/11",
    "ssn": null,
    "original_effective_date": null,
    "change_effective_date": null,
    "termination_date": null,
    "union_code": "HR",
    "employment_level": null,
    "pay_rate": "40.0",
    "pay_type": null,
    "org_payroll_id": "563",
    "employee_number": "2",
    "public_id": 988618,
    "marital_status": "M",
    "division": "A",
    "location": "FLORIDA",
    "org_class": "HOURLY",
    "business_title": "MR",
    "udef_1": null,
    "udef_2": null,
    "udef_3": null,
    "udef_4": null,
    "udef_5": null,
    "udef_6": null,
    "udef_7": null,
    "udef_8": null,
    "udef_9": null,
    "udef_10": null,
    "udef_11": null,
    "udef_12": null,
    "udef_13": null,
    "udef_14": null,
    "udef_15": null,
    "udef_16": null,
    "udef_17": null,
    "udef_18": null,
    "udef_19": null,
    "udef_20": null,
    "ee_code": null,
    "benefit_company": null,
    "original_hire_date": "2006/06/13",
    "seniority_date": null,
    "employment_status": null,
    "employment_status_starts_on": null,
    "employment_status_ends_on": null,
    "employee_type": null,
    "current_salary_effective_on": "2006/06/13",
    "current_salary": "70000.0",
    "benefit_deduction_group": null,
    "highly_compensated": null,
    "vip": null,
    "fmla": null,
    "name_suffix": null,
    "subscriber_status_id": 15,
    "status_changed_at": "2006/06/1300: 00: 00-0400",
    "status_starts_on": "2006/06/13",
    "status_ends_on": null,
    "benefits_start_date": "2006/06/13",
    "benefits_end_date": null,
    "parent_dependent_id": null,
    "status_ends_on_expected": null,
    "subscriber_status_subtype_id": null,
    "org_admin_enroll_reason_id": null,
    "test_employee": false,
    "is_voluntary_termination": false,
    "hide_from_payroll": false,
    "termination_reason_id": null,
    "bank_account_type": null,
    "ssn_exported": false,
    "eligible_org_population_ids": null,
    "shareholder": false,
    "owner": false,
    "anthem_hcid": null,
    "anthem_member_code": null,
    "written_language": null,
    "spoken_language": null,
    "exclude_from_batch_import": false,
    "anthem_sub_id": null,
    "hours_per_week": null,
    "medicare_reason": null,
    "medicare_plan": null,
    "medicare_effective_date": null,
    "medicare_termination_date": null,
    "is_smoker": null,
    "anthem_emp_dept_code": null,
    "county": null,
    "udef_21": null,
    "udef_22": null,
    "udef_23": null,
    "udef_24": null,
    "udef_25": null,
    "udef_26": null,
    "udef_27": null,
    "udef_28": null,
    "udef_29": null,
    "udef_30": null,
    "is_aca_full_time_for_enrollment": null,
    "email": null,
    "user_name": "jtest_7",
    "email2": null,
    "locked_at": null,
    "attempted_logon_count": 0,
    "disabled_on": null,
    "preferred_locale": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "No employee with id: 8854530 found",
    "details": null,
    "error_code": 404
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

id
int64
required

The ID of the subscriber.

Query Params

is_custom_id
boolean

Set to true if the {id} in the path is customer generated.

Response

Subscriber retrieval response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
subscriber_codestring
first_namestring
last_namestring
middle_namestring
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
home_phonestring
work_phonestring
cell_phonestring
genderstring
hire_datestring
birthdatestring
ssnstring
original_effective_datestring
change_effective_datestring
termination_datestring
union_codestring
employment_levelstring
pay_ratestring
pay_typestring
org_payroll_idinteger
employee_numberstring
public_idinteger
marital_statusstring
divisionstring
locationstring
org_classstring
business_titlestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
udef_11string
udef_12string
udef_13string
udef_14string
udef_15string
udef_16string
udef_17string
udef_18string
udef_19string
udef_20string
ee_codestring
benefit_companystring
original_hire_datestring
seniority_datestring
employment_statusstring
employment_status_starts_onstring
employment_status_ends_onstring
employee_typestring
current_salary_effective_onstring
current_salarystring
benefit_deduction_groupstring
highly_compensatedstring
vipstring
fmlastring
name_suffixstring
subscriber_status_idstring
status_changed_atstring
status_starts_onstring
status_ends_onstring
benefits_start_datestring
benefits_end_datestring
parent_dependent_idstring
status_ends_on_expectedstring
subscriber_status_subtype_idstring
org_admin_enroll_reason_idstring
test_employeeboolean
is_voluntary_terminationstring
hide_from_payrollstring
termination_reason_idstring
bank_account_typestring
ssn_exportedboolean
eligible_org_population_idsstring
shareholderstring
ownerstring
anthem_hcidstring
anthem_member_codestring
written_languagestring
spoken_languagestring
exclude_from_batch_importstring
anthem_sub_idstring
hours_per_weekstring
medicare_reasonstring
medicare_planstring
medicare_effective_datestring
medicare_termination_datestring
is_smokerstring
anthem_emp_dept_codestring
countystring
udef_21string
udef_22string
udef_23string
udef_24string
udef_25string
udef_26string
udef_27string
udef_28string
udef_29string
udef_30string
is_aca_full_time_for_enrollmentstring
emailstring
user_namestring
email2string
locked_atstring
attemtped_logon_countinteger
disabled_onstring
preferred_localestring

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscriber/{id}

Update data for a subscriber.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
puthttps://partner-dev-api.plansource.com/admin/v2/subscriber/id
curl --request PUT \
  --url https://partner-dev-api.plansource.com/admin/v2/subscriber/id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscriber/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscriber/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://partner-dev-api.plansource.com/admin/v2/subscriber/id");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscriber/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12186626",
      "rel": "self"
    },
    "id": 12186626,
    "subscriber_code": null,
    "first_name": "John",
    "last_name": "Test",
    "middle_name": "M",
    "address_1": "1234TestSt.",
    "address_2": "",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "32801",
    "country": "United States",
    "home_phone": "4071231234",
    "work_phone": "4071231234",
    "cell_phone": "4071231234",
    "gender": "M",
    "hire_date": "2006/06/13",
    "birthdate": "1990/03/11",
    "ssn": null,
    "original_effective_date": null,
    "change_effective_date": null,
    "termination_date": null,
    "union_code": "HR",
    "employment_level": null,
    "pay_rate": "40.0",
    "pay_type": null,
    "org_payroll_id": "563",
    "employee_number": "2",
    "public_id": 988618,
    "marital_status": "M",
    "division": "A",
    "location": "FLORIDA",
    "org_class": "HOURLY",
    "business_title": "MR",
    "udef_1": null,
    "udef_2": null,
    "udef_3": null,
    "udef_4": null,
    "udef_5": null,
    "udef_6": null,
    "udef_7": null,
    "udef_8": null,
    "udef_9": null,
    "udef_10": null,
    "udef_11": null,
    "udef_12": null,
    "udef_13": null,
    "udef_14": null,
    "udef_15": null,
    "udef_16": null,
    "udef_17": null,
    "udef_18": null,
    "udef_19": null,
    "udef_20": null,
    "ee_code": null,
    "benefit_company": null,
    "original_hire_date": "2006/06/13",
    "seniority_date": null,
    "employment_status": null,
    "employment_status_starts_on": null,
    "employment_status_ends_on": null,
    "employee_type": null,
    "current_salary_effective_on": "2006/06/13",
    "current_salary": "70000.0",
    "benefit_deduction_group": null,
    "highly_compensated": null,
    "vip": null,
    "fmla": null,
    "name_suffix": null,
    "subscriber_status_id": 15,
    "status_changed_at": "2006/06/1300: 00: 00-0400",
    "status_starts_on": "2006/06/13",
    "status_ends_on": null,
    "benefits_start_date": "2006/06/13",
    "benefits_end_date": null,
    "parent_dependent_id": null,
    "status_ends_on_expected": null,
    "subscriber_status_subtype_id": null,
    "org_admin_enroll_reason_id": null,
    "test_employee": false,
    "is_voluntary_termination": false,
    "hide_from_payroll": false,
    "termination_reason_id": null,
    "bank_account_type": null,
    "ssn_exported": false,
    "eligible_org_population_ids": null,
    "shareholder": false,
    "owner": false,
    "anthem_hcid": null,
    "anthem_member_code": null,
    "written_language": null,
    "spoken_language": null,
    "exclude_from_batch_import": false,
    "anthem_sub_id": null,
    "hours_per_week": null,
    "medicare_reason": null,
    "medicare_plan": null,
    "medicare_effective_date": null,
    "medicare_termination_date": null,
    "is_smoker": null,
    "anthem_emp_dept_code": null,
    "county": null,
    "udef_21": null,
    "udef_22": null,
    "udef_23": null,
    "udef_24": null,
    "udef_25": null,
    "udef_26": null,
    "udef_27": null,
    "udef_28": null,
    "udef_29": null,
    "udef_30": null,
    "is_aca_full_time_for_enrollment": null,
    "email": null,
    "user_name": "jtest_7",
    "email2": null,
    "locked_at": null,
    "attempted_logon_count": 0,
    "disabled_on": null,
    "preferred_locale": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "State must be a valid State abbreviation.",
    "details": null,
    "error_code": 400
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'subscribr/12196354' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

id
int64
required

The ID of the subscriber.

Query Params

is_custom_id
boolean

Set to true if the {id} in the path is customer generated.

Body Params

subscriber_code
string
first_name
string
last_name
string
middle_name
string
address_1
string
address_2
string
city
string
state
string

Valid values are based on what is retrieved from meta resource.

zip_code
string
country
string

Valid values are based on what is retrieved from meta resource.

home_phone
string
work_phone
string
cell_phone
string
gender
string

Valid values are based on what is retrieved from meta resource.

hire_date
string

YYYY-MM-DD date format.

birthdate
string

YYYY-MM-DD date format.

ssn
string
original_effective_date
string

YYYY-MM-DD date format.

change_effective_date
string

YYYY-MM-DD date format.

termination_date
string

YYYY-MM-DD date format.

union_code
string
employment_level
string

Valid values are based on what is retrieved from meta resource.

pay_rate
string
pay_type
string
org_payroll_id
string

Valid values are based on what is retrieved from meta resource.

employee_number
string
public_id
string
marital_status
string

Valid values are based on what is retrieved from meta resource.

division
string
location
string
org_class
string
business_title
string
udef_1
string
udef_2
string
udef_3
string
udef_4
string
udef_5
string
udef_6
string
udef_7
string
udef_8
string
udef_9
string
udef_10
string
udef_11
string
udef_12
string
udef_13
string
udef_14
string
udef_15
string
udef_16
string
udef_17
string
udef_18
string
udef_19
string
udef_20
string
ee_code
string
benefit_company
string
original_hire_date
string

YYYY-MM-DD date format.

seniority_date
string

YYYY-MM-DD date format.

employment_status
string
employment_status_starts_on
string
employment_status_ends_on
string
employee_type
string
current_salary_effective_on
string

YYYY-MM-DD date format.

current_salary
string
benefit_deduction_group
string
highly_compensated
boolean
vip
boolean
fmla
boolean
name_suffix
string
subscriber_status_id
string
status_changed_at
string

YYYY-MM-DD date format.

status_starts_on
string

YYYY-MM-DD date format.

status_ends_on
string

YYYY-MM-DD date format.

benefits_start_date
string

YYYY-MM-DD date format.

benefits_end_date
string

YYYY-MM-DD date format.

parent_dependent_id
string
status_ends_on_expected
string

YYYY-MM-DD date format.

subscriber_status_subtype_id
string
test_employee
boolean
is_voluntary_termination
boolean
hide_from_payroll
boolean
termination_reason_id
string
bank_account_type
string
ssn_exported
boolean
eligible_org_population_ids
string
shareholder
boolean
owner
boolean
anthem_hcid
string
anthem_member_code
string
written_language
string

Valid values are based on what is retrieved from meta resource.

spoken_language
string

Valid values are based on what is retrieved from meta resource.

exclude_from_batch_import
boolean
anthem_sub_id
string
hours_per_week
string
medicare_reason
string

Valid values are based on what is retrieved from meta resource.

medicare_plan
string

Valid values are based on what is retrieved from meta resource.

medicare_effective_date
string

YYYY-MM-DD date format.

medicare_termination_date
string

YYYY-MM-DD date format.

is_smoker
string

Valid values are based on what is retrieved from meta resource.

anthem_emp_dept_code
string

Valid values are based on what is retrieved from meta resource.

county
string
udef_21
string
udef_22
string
udef_23
string
udef_24
string
udef_25
string
udef_26
string
udef_27
string
udef_28
string
udef_29
string
udef_30
string
email
string
user_name
string
email2
string
locked_at
string
attempted_logon_count
string
disabled_on
string
preferred_locale
string

Response

Subscriber update response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
subscriber_codestring
first_namestring
last_namestring
middle_namestring
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
home_phonestring
work_phonestring
cell_phonestring
genderstring
hire_datestring
birthdatestring
ssnstring
original_effective_datestring
change_effective_datestring
termination_datestring
union_codestring
employment_levelstring
pay_ratestring
pay_typestring
org_payroll_idinteger
employee_numberstring
public_idinteger
marital_statusstring
divisionstring
locationstring
org_classstring
business_titlestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
udef_11string
udef_12string
udef_13string
udef_14string
udef_15string
udef_16string
udef_17string
udef_18string
udef_19string
udef_20string
ee_codestring
benefit_companystring
original_hire_datestring
seniority_datestring
employment_statusstring
employment_status_starts_onstring
employment_status_ends_onstring
employee_typestring
current_salary_effective_onstring
current_salarystring
benefit_deduction_groupstring
highly_compensatedstring
vipstring
fmlastring
name_suffixstring
subscriber_status_idstring
status_changed_atstring
status_starts_onstring
status_ends_onstring
benefits_start_datestring
benefits_end_datestring
parent_dependent_idstring
status_ends_on_expectedstring
subscriber_status_subtype_idstring
org_admin_enroll_reason_idstring
test_employeeboolean
is_voluntary_terminationstring
hide_from_payrollstring
termination_reason_idstring
bank_account_typestring
ssn_exportedboolean
eligible_org_population_idsstring
shareholderstring
ownerstring
anthem_hcidstring
anthem_member_codestring
written_languagestring
spoken_languagestring
exclude_from_batch_importstring
anthem_sub_idstring
hours_per_weekstring
medicare_reasonstring
medicare_planstring
medicare_effective_datestring
medicare_termination_datestring
is_smokerstring
anthem_emp_dept_codestring
countystring
udef_21string
udef_22string
udef_23string
udef_24string
udef_25string
udef_26string
udef_27string
udef_28string
udef_29string
udef_30string
is_aca_full_time_for_enrollmentstring
emailstring
user_namestring
email2string
locked_atstring
attemtped_logon_countinteger
disabled_onstring
preferred_localestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscriber/{id}/terminate

Terminate a subscriber.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
puthttps://partner-dev-api.plansource.com/admin/v2/subscriber/id/terminate
curl --request PUT \
  --url https://partner-dev-api.plansource.com/admin/v2/subscriber/id/terminate
var request = require("request");

var options = { method: 'PUT',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscriber/id/terminate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscriber/id/terminate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://partner-dev-api.plansource.com/admin/v2/subscriber/id/terminate");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscriber/id/terminate"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12186626",
      "rel": "self"
    },
    "id": 12186626,
    "subscriber_code": null,
    "first_name": "John",
    "last_name": "Test",
    "middle_name": "M",
    "address_1": "1234TestSt.",
    "address_2": "",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "32801",
    "country": "United States",
    "home_phone": "4071231234",
    "work_phone": "4071231234",
    "cell_phone": "4071231234",
    "gender": "M",
    "hire_date": "2006/06/13",
    "birthdate": "1990/03/11",
    "ssn": null,
    "original_effective_date": null,
    "change_effective_date": null,
    "termination_date": "2018/04/08",
    "union_code": "HR",
    "employment_level": null,
    "pay_rate": "40.0",
    "pay_type": null,
    "org_payroll_id": "563",
    "employee_number": "2",
    "public_id": 988618,
    "marital_status": "M",
    "division": "A",
    "location": "FLORIDA",
    "org_class": "HOURLY",
    "business_title": "MR",
    "udef_1": null,
    "udef_2": null,
    "udef_3": null,
    "udef_4": null,
    "udef_5": null,
    "udef_6": null,
    "udef_7": null,
    "udef_8": null,
    "udef_9": null,
    "udef_10": null,
    "udef_11": null,
    "udef_12": null,
    "udef_13": null,
    "udef_14": null,
    "udef_15": null,
    "udef_16": null,
    "udef_17": null,
    "udef_18": null,
    "udef_19": null,
    "udef_20": null,
    "ee_code": null,
    "benefit_company": null,
    "original_hire_date": "2006/06/13",
    "seniority_date": null,
    "employment_status": null,
    "employment_status_starts_on": null,
    "employment_status_ends_on": null,
    "employee_type": null,
    "current_salary_effective_on": "2006/06/13",
    "current_salary": "70000.0",
    "benefit_deduction_group": null,
    "highly_compensated": null,
    "vip": null,
    "fmla": null,
    "name_suffix": null,
    "subscriber_status_id": 15,
    "status_changed_at": "2006/06/1300: 00: 00-0400",
    "status_starts_on": "2006/06/13",
    "status_ends_on": null,
    "benefits_start_date": "2006/06/13",
    "benefits_end_date": null,
    "parent_dependent_id": null,
    "status_ends_on_expected": null,
    "subscriber_status_subtype_id": null,
    "org_admin_enroll_reason_id": null,
    "test_employee": false,
    "is_voluntary_termination": true,
    "hide_from_payroll": false,
    "termination_reason_id": 3,
    "bank_account_type": null,
    "ssn_exported": false,
    "eligible_org_population_ids": null,
    "shareholder": false,
    "owner": false,
    "anthem_hcid": null,
    "anthem_member_code": null,
    "written_language": null,
    "spoken_language": null,
    "exclude_from_batch_import": false,
    "anthem_sub_id": null,
    "hours_per_week": null,
    "medicare_reason": null,
    "medicare_plan": null,
    "medicare_effective_date": null,
    "medicare_termination_date": null,
    "is_smoker": null,
    "anthem_emp_dept_code": null,
    "county": null,
    "udef_21": null,
    "udef_22": null,
    "udef_23": null,
    "udef_24": null,
    "udef_25": null,
    "udef_26": null,
    "udef_27": null,
    "udef_28": null,
    "udef_29": null,
    "udef_30": null,
    "is_aca_full_time_for_enrollment": null,
    "email": null,
    "user_name": "jtest_7",
    "email2": null,
    "locked_at": null,
    "attempted_logon_count": 0,
    "disabled_on": null,
    "preferred_locale": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Cannot perform action as the employee is terminated",
    "details": null,
    "error_code": 400
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'subscriber/12187650/terminat' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

id
int64
required

The ID of the subscriber to terminate.

Query Params

is_custom_id
boolean

Set to true if the {id} in the path is customer generated.

Body Params

termination_reason
string

Valid values are based on what is retrieved from meta resource.

termination_date
string

YYYY-MM-DD date format.

volunatary
boolean

Response

Subscriber terminate response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
subscriber_codestring
first_namestring
last_namestring
middle_namestring
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
home_phonestring
work_phonestring
cell_phonestring
genderstring
hire_datestring
birthdatestring
ssnstring
original_effective_datestring
change_effective_datestring
termination_datestring
union_codestring
employment_levelstring
pay_ratestring
pay_typestring
org_payroll_idinteger
employee_numberstring
public_idinteger
marital_statusstring
divisionstring
locationstring
org_classstring
business_titlestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
udef_11string
udef_12string
udef_13string
udef_14string
udef_15string
udef_16string
udef_17string
udef_18string
udef_19string
udef_20string
ee_codestring
benefit_companystring
original_hire_datestring
seniority_datestring
employment_statusstring
employment_status_starts_onstring
employment_status_ends_onstring
employee_typestring
current_salary_effective_onstring
current_salarystring
benefit_deduction_groupstring
highly_compensatedstring
vipstring
fmlastring
name_suffixstring
subscriber_status_idstring
status_changed_atstring
status_starts_onstring
status_ends_onstring
benefits_start_datestring
benefits_end_datestring
parent_dependent_idstring
status_ends_on_expectedstring
subscriber_status_subtype_idstring
org_admin_enroll_reason_idstring
test_employeeboolean
is_voluntary_terminationstring
hide_from_payrollstring
termination_reason_idstring
bank_account_typestring
ssn_exportedboolean
eligible_org_population_idsstring
shareholderstring
ownerstring
anthem_hcidstring
anthem_member_codestring
written_languagestring
spoken_languagestring
exclude_from_batch_importstring
anthem_sub_idstring
hours_per_weekstring
medicare_reasonstring
medicare_planstring
medicare_effective_datestring
medicare_termination_datestring
is_smokerstring
anthem_emp_dept_codestring
countystring
udef_21string
udef_22string
udef_23string
udef_24string
udef_25string
udef_26string
udef_27string
udef_28string
udef_29string
udef_30string
is_aca_full_time_for_enrollmentstring
emailstring
user_namestring
email2string
locked_atstring
attemtped_logon_countinteger
disabled_onstring
preferred_localestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscriber/{id}/rehire

Rehire a subscriber.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
puthttps://partner-dev-api.plansource.com/admin/v2/subscriber/id/rehire
curl --request PUT \
  --url https://partner-dev-api.plansource.com/admin/v2/subscriber/id/rehire
var request = require("request");

var options = { method: 'PUT',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscriber/id/rehire' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscriber/id/rehire")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://partner-dev-api.plansource.com/admin/v2/subscriber/id/rehire");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscriber/id/rehire"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12186626",
      "rel": "self"
    },
    "id": 12186626,
    "subscriber_code": null,
    "first_name": "John",
    "last_name": "Test",
    "middle_name": "M",
    "address_1": "1234TestSt.",
    "address_2": "",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "32801",
    "country": "United States",
    "home_phone": "4071231234",
    "work_phone": "4071231234",
    "cell_phone": "4071231234",
    "gender": "M",
    "hire_date": "2018/07/08",
    "birthdate": "1990/03/11",
    "ssn": null,
    "original_effective_date": null,
    "change_effective_date": null,
    "termination_date": null,
    "union_code": "HR",
    "employment_level": null,
    "pay_rate": "40.0",
    "pay_type": null,
    "org_payroll_id": "563",
    "employee_number": "2",
    "public_id": 988618,
    "marital_status": "M",
    "division": "A",
    "location": "FLORIDA",
    "org_class": "HOURLY",
    "business_title": "MR",
    "udef_1": null,
    "udef_2": null,
    "udef_3": null,
    "udef_4": null,
    "udef_5": null,
    "udef_6": null,
    "udef_7": null,
    "udef_8": null,
    "udef_9": null,
    "udef_10": null,
    "udef_11": null,
    "udef_12": null,
    "udef_13": null,
    "udef_14": null,
    "udef_15": null,
    "udef_16": null,
    "udef_17": null,
    "udef_18": null,
    "udef_19": null,
    "udef_20": null,
    "ee_code": null,
    "benefit_company": null,
    "original_hire_date": "2006/06/13",
    "seniority_date": null,
    "employment_status": null,
    "employment_status_starts_on": null,
    "employment_status_ends_on": null,
    "employee_type": null,
    "current_salary_effective_on": "2006/06/13",
    "current_salary": "70000.0",
    "benefit_deduction_group": null,
    "highly_compensated": null,
    "vip": null,
    "fmla": null,
    "name_suffix": null,
    "subscriber_status_id": 15,
    "status_changed_at": "2006/06/1300: 00: 00-0400",
    "status_starts_on": "2018/07/08",
    "status_ends_on": null,
    "benefits_start_date": "2018/07/08",
    "benefits_end_date": null,
    "parent_dependent_id": null,
    "status_ends_on_expected": null,
    "subscriber_status_subtype_id": null,
    "org_admin_enroll_reason_id": null,
    "test_employee": false,
    "is_voluntary_termination": false,
    "hide_from_payroll": false,
    "termination_reason_id": null,
    "bank_account_type": null,
    "ssn_exported": false,
    "eligible_org_population_ids": null,
    "shareholder": false,
    "owner": false,
    "anthem_hcid": null,
    "anthem_member_code": null,
    "written_language": null,
    "spoken_language": null,
    "exclude_from_batch_import": false,
    "anthem_sub_id": null,
    "hours_per_week": null,
    "medicare_reason": null,
    "medicare_plan": null,
    "medicare_effective_date": null,
    "medicare_termination_date": null,
    "is_smoker": null,
    "anthem_emp_dept_code": null,
    "county": null,
    "udef_21": null,
    "udef_22": null,
    "udef_23": null,
    "udef_24": null,
    "udef_25": null,
    "udef_26": null,
    "udef_27": null,
    "udef_28": null,
    "udef_29": null,
    "udef_30": null,
    "is_aca_full_time_for_enrollment": null,
    "email": null,
    "user_name": "jtest_7",
    "email2": null,
    "locked_at": null,
    "attempted_logon_count": 0,
    "disabled_on": null,
    "preferred_locale": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Cannot perform action as the employee is not terminated",
    "details": null,
    "error_code": 400
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'subscriber/12187650/rehir' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

id
int64
required

The ID of the subscriber to rehire.

Query Params

is_custom_id
boolean

Set to true if the {id} in the path is customer generated.

Body Params

rehire_date
string

YYYY-MM-DD date format.

Response

Subscriber rehire response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
subscriber_codestring
first_namestring
last_namestring
middle_namestring
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
home_phonestring
work_phonestring
cell_phonestring
genderstring
hire_datestring
birthdatestring
ssnstring
original_effective_datestring
change_effective_datestring
termination_datestring
union_codestring
employment_levelstring
pay_ratestring
pay_typestring
org_payroll_idinteger
employee_numberstring
public_idinteger
marital_statusstring
divisionstring
locationstring
org_classstring
business_titlestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
udef_11string
udef_12string
udef_13string
udef_14string
udef_15string
udef_16string
udef_17string
udef_18string
udef_19string
udef_20string
ee_codestring
benefit_companystring
original_hire_datestring
seniority_datestring
employment_statusstring
employment_status_starts_onstring
employment_status_ends_onstring
employee_typestring
current_salary_effective_onstring
current_salarystring
benefit_deduction_groupstring
highly_compensatedstring
vipstring
fmlastring
name_suffixstring
subscriber_status_idstring
status_changed_atstring
status_starts_onstring
status_ends_onstring
benefits_start_datestring
benefits_end_datestring
parent_dependent_idstring
status_ends_on_expectedstring
subscriber_status_subtype_idstring
org_admin_enroll_reason_idstring
test_employeeboolean
is_voluntary_terminationstring
hide_from_payrollstring
termination_reason_idstring
bank_account_typestring
ssn_exportedboolean
eligible_org_population_idsstring
shareholderstring
ownerstring
anthem_hcidstring
anthem_member_codestring
written_languagestring
spoken_languagestring
exclude_from_batch_importstring
anthem_sub_idstring
hours_per_weekstring
medicare_reasonstring
medicare_planstring
medicare_effective_datestring
medicare_termination_datestring
is_smokerstring
anthem_emp_dept_codestring
countystring
udef_21string
udef_22string
udef_23string
udef_24string
udef_25string
udef_26string
udef_27string
udef_28string
udef_29string
udef_30string
is_aca_full_time_for_enrollmentstring
emailstring
user_namestring
email2string
locked_atstring
attemtped_logon_countinteger
disabled_onstring
preferred_localestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscriber/{subscriber_id}/dependent

Create a dependent resource.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
posthttps://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent
curl --request POST \
  --url https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent
var request = require("request");

var options = { method: 'POST',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12206082/dependent/2078210",
      "rel": "self"
    },
    "id": 2078210,
    "public_id": 2078210,
    "ssn": "XXX-XX-8782",
    "first_name": "TestFirst",
    "middle_name": "TestMiddle",
    "last_name": "TestLast",
    "name_suffix": "Mr.",
    "hide_dependent_on_termination": false,
    "qmcso_benefits": null,
    "termination_reason_id": 3,
    "medicare_effective_date": "2018/01/13",
    "medicare_plan": "PART A",
    "medicare_reason": "AGE",
    "medicare_termination_date": "2018/02/01",
    "birthdate": "2000/08/01",
    "gender": "M",
    "relationship_code": "child",
    "qmcso": null,
    "lives_at_home": false,
    "address_1": "111 Lane Dr.",
    "address_2": "Apt. 21",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "34786",
    "country": "United States",
    "is_smoker": "NO",
    "verified": true,
    "verification_expires_on": "2018/03/01",
    "termination_date": "2018/07/01",
    "udef_1": "custom",
    "udef_2": "custom",
    "udef_3": "custom",
    "udef_4": "custom",
    "udef_5": "custom",
    "udef_6": "custom",
    "udef_7": "custom",
    "udef_8": "custom",
    "udef_9": "custom",
    "udef_10": "custom",
    "has_worksite_coverage": null,
    "anthem_member_code": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Invalid Attributes: first_name is/are required.",
    "details": null,
    "error_code": 400
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'subscriber/12206082/dependen' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

subscriber_id
int64
required

The ID of the subscriber.

Query Params

is_custom_id
boolean

Set to true if the {subscriber_id} in the path is customer generated.

Body Params

ssn
string
first_name
string
middle_name
string
last_name
string
name_suffix
string
hide_dependent_on_termination
boolean
qmcso_benefits
string
termination_reason_id
string
medicare_effective_date
string

YYYY-MM-DD date format.

medicare_plan
string

Valid values are based on what is retrieved from meta resources.

medicare_reason
string

Valid values are based on what is retrieved from meta resources.

medicare_termination_date
string

YYYY-MM-DD date format.

birthdate
string

YYYY-MM-DD date format.

gender
string

Valid values are based on what is retrieved from meta resources.

relationship_code
string

Valid values are based on what is retrieved from meta resources.

qmcso
string
lives_at_home
boolean
address_1
string
address_2
string
city
string
state
string

Valid values are based on what is retrieved from meta resources.

zip_code
string
country
string

Valid values are based on what is retrieved from meta resources.

is_smoker
string

Valid values are based on what is retrieved from meta resources.

verified
boolean
verification_expires_on
string

YYYY-MM-DD date format.

termination_date
string

YYYY-MM-DD date format.

udef_1
string
udef_2
string
udef_3
string
udef_4
string
udef_5
string
udef_6
string
udef_7
string
udef_8
string
udef_9
string
udef_10
string
anthem_member_code
string

Response

Dependent create response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
public_idinteger
ssnstring
first_namestring
middle_namestring
last_namestring
name_suffixstring
hide_dependent_on_terminationboolean
org_relationship_idinteger
qmcso_benefitsstring
termination_reason_idstring
medicare_effective_datestring
medicare_planstring
medicare_reasonstring
medicare_termination_datestring
birthdatestring
genderstring
relationship_codestring
qmcsostring
lives_at_homeboolean
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
is_smokerstring
verifiedboolean
verification_expires_onstring
termination_datestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
has_worksite_coverageboolean
anthem_member_codestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/dependent/meta

Retrieve meta data for dependent.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
gethttps://partner-dev-api.plansource.com/admin/v2/dependent/meta
curl --request GET \
  --url https://partner-dev-api.plansource.com/admin/v2/dependent/meta
var request = require("request");

var options = { method: 'GET',
  url: 'https://partner-dev-api.plansource.com/admin/v2/dependent/meta' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/dependent/meta")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://partner-dev-api.plansource.com/admin/v2/dependent/meta");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/dependent/meta"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "hide_dependent_on_termination": {
      "update": true,
      "required": false,
      "caption": "Hide dependent on termination",
      "data_type": "BOOLEAN",
      "validation_data": [
        "F",
        "F"
      ]
    },
    "gender": {
      "update": true,
      "required": false,
      "caption": "Gender",
      "data_type": "STRING",
      "validation": [
        "Male",
        "M"
      ]
    },
    "relationship_code": {
      "update": true,
      "required": false,
      "caption": "Relationship",
      "data_type": "STRING",
      "validation": [
        "Spouse",
        "Spouse"
      ]
    },
    "state": {
      "update": true,
      "required": false,
      "caption": "State",
      "data_type": "STRING",
      "validation": [
        "Alabama",
        "AL"
      ]
    },
    "country": {
      "update": true,
      "required": false,
      "caption": "Country",
      "data_type": "STRING",
      "validation": [
        "Lebanon",
        "Lebanon"
      ]
    },
    "is_smoker": {
      "update": true,
      "required": false,
      "caption": "Tobacco User",
      "data_type": "STRING",
      "validation": [
        "YES",
        "YES"
      ]
    },
    "termination_reason": {
      "update": true,
      "required": false,
      "caption": "Termination Reason",
      "data_type": "NUMBER",
      "validation": {
        "lookup_code": "divorce",
        "name": "Divorce (COBRA)",
        "description": "Spouse Divorced from employee"
      }
    }
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "No Employee ID in the request.",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'dependen/meta' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Response

List of meta data for dependent.

statusstring
errorsarray
dataarray
hide_dependent_on_terminationarray
genderarray
relationship_codearray
statearray
countryarray
is_smokerarray
termination_reasonarray

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscriber/{subscriber_id}/dependent/{id}

Retrieve data for a dependent.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
gethttps://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id
curl --request GET \
  --url https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12206082/dependent/2078210",
      "rel": "self"
    },
    "id": 2078210,
    "public_id": 2078210,
    "ssn": "XXX-XX-8782",
    "first_name": "TestFirst",
    "middle_name": "TestMiddle",
    "last_name": "TestLast",
    "name_suffix": "Mr.",
    "hide_dependent_on_termination": false,
    "qmcso_benefits": null,
    "termination_reason_id": 3,
    "medicare_effective_date": "2018/01/13",
    "medicare_plan": "PART A",
    "medicare_reason": "AGE",
    "medicare_termination_date": "2018/02/01",
    "birthdate": "2000/08/01",
    "gender": "M",
    "relationship_code": "child",
    "qmcso": null,
    "lives_at_home": false,
    "address_1": "111 Lane Dr.",
    "address_2": "Apt. 21",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "34786",
    "country": "United States",
    "is_smoker": "NO",
    "verified": true,
    "verification_expires_on": "2018/03/01",
    "termination_date": "2018/07/01",
    "udef_1": "custom",
    "udef_2": "custom",
    "udef_3": "custom",
    "udef_4": "custom",
    "udef_5": "custom",
    "udef_6": "custom",
    "udef_7": "custom",
    "udef_8": "custom",
    "udef_9": "custom",
    "udef_10": "custom",
    "has_worksite_coverage": null,
    "anthem_member_code": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "The dependent does not belong to this employee.",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'subscriber/12206082/dependent2078722' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

subscriber_id
int64
required

The ID of the subscriber.

id
int64
required

The ID of the dependent to fetch.

Query Params

is_custom_id
boolean

Set to true if the {subscriber_id} in the path is customer generated.

Response

Dependent retrieval response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
public_idinteger
ssnstring
first_namestring
middle_namestring
last_namestring
name_suffixstring
hide_dependent_on_terminationboolean
org_relationship_idinteger
qmcso_benefitsstring
termination_reason_idstring
medicare_effective_datestring
medicare_planstring
medicare_reasonstring
medicare_termination_datestring
birthdatestring
genderstring
relationship_codestring
qmcsostring
lives_at_homeboolean
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
is_smokerstring
verifiedboolean
verification_expires_onstring
termination_datestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
has_worksite_coverageboolean
anthem_member_codestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscriber/{subscriber_id}/dependent/{id}

Update data for a dependent.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
puthttps://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id
curl --request PUT \
  --url https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12206082/dependent/2078210",
      "rel": "self"
    },
    "id": 2078210,
    "public_id": 2078210,
    "ssn": "XXX-XX-8782",
    "first_name": "TestFirst",
    "middle_name": "TestMiddle",
    "last_name": "TestLast",
    "name_suffix": "Mr.",
    "hide_dependent_on_termination": false,
    "qmcso_benefits": null,
    "termination_reason_id": 3,
    "medicare_effective_date": "2018/01/13",
    "medicare_plan": "PART A",
    "medicare_reason": "AGE",
    "medicare_termination_date": "2018/02/01",
    "birthdate": "2000/08/01",
    "gender": "M",
    "relationship_code": "child",
    "qmcso": null,
    "lives_at_home": false,
    "address_1": "111 Lane Dr.",
    "address_2": "Apt. 21",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "34786",
    "country": "United States",
    "is_smoker": "NO",
    "verified": true,
    "verification_expires_on": "2018/03/01",
    "termination_date": "2018/07/01",
    "udef_1": "custom",
    "udef_2": "custom",
    "udef_3": "custom",
    "udef_4": "custom",
    "udef_5": "custom",
    "udef_6": "custom",
    "udef_7": "custom",
    "udef_8": "custom",
    "udef_9": "custom",
    "udef_10": "custom",
    "has_worksite_coverage": null,
    "anthem_member_code": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "undefined method `gsub' for nil:NilClass",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Invalid dependent.  The dependent ID does not exist.",
    "details": null,
    "error_code": 404
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

subscriber_id
int64
required

The ID of the subscriber.

id
int64
required

The ID of the dependent to update.

Query Params

is_custom_id
boolean

Set to true if the {subscriber_id} in the path is customer generated.

Body Params

ssn
string
first_name
string
middle_name
string
last_name
string
name_suffix
string
hide_dependent_on_termination
boolean
qmcso_benefits
string
termination_reason_id
string
medicare_effective_date
string

YYYY-MM-DD date format.

medicare_plan
string

Valid values are based on what is retrieved from meta resources.

medicare_reason
string

Valid values are based on what is retrieved from meta resources.

medicare_termination_date
string

YYYY-MM-DD date format.

birthdate
string

YYYY-MM-DD date format.

gender
string

Valid values are based on what is retrieved from meta resources.

relationship_code
string

Valid values are based on what is retrieved from meta resources.

qmcso
string
lives_at_home
boolean
address_1
string
address_2
string
city
string
state
string

Valid values are based on what is retrieved from meta resources.

zip_code
string
country
string

Valid values are based on what is retrieved from meta resources.

is_smoker
string

Valid values are based on what is retrieved from meta resources.

verified
boolean
verification_expires_on
string

YYYY-MM-DD date format.

termination_date
string

YYYY-MM-DD date format.

udef_1
string
udef_2
string
udef_3
string
udef_4
string
udef_5
string
udef_6
string
udef_7
string
udef_8
string
udef_9
string
udef_10
string
anthem_member_code
string

Response

Dependent update response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
public_idinteger
ssnstring
first_namestring
middle_namestring
last_namestring
name_suffixstring
hide_dependent_on_terminationboolean
org_relationship_idinteger
qmcso_benefitsstring
termination_reason_idstring
medicare_effective_datestring
medicare_planstring
medicare_reasonstring
medicare_termination_datestring
birthdatestring
genderstring
relationship_codestring
qmcsostring
lives_at_homeboolean
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
is_smokerstring
verifiedboolean
verification_expires_onstring
termination_datestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
has_worksite_coverageboolean
anthem_member_codestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscriber/{subscriber_id}/dependent/{id}/deactivate

Deactivate a dependent.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
puthttps://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id/deactivate
curl --request PUT \
  --url https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id/deactivate
var request = require("request");

var options = { method: 'PUT',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id/deactivate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id/deactivate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id/deactivate");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id/deactivate"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12206082/dependent/2078210",
      "rel": "self"
    },
    "id": 2078210,
    "public_id": 2078210,
    "ssn": "XXX-XX-8782",
    "first_name": "TestFirst",
    "middle_name": "TestMiddle",
    "last_name": "TestLast",
    "name_suffix": "Mr.",
    "hide_dependent_on_termination": false,
    "qmcso_benefits": null,
    "termination_reason_id": 7,
    "medicare_effective_date": "2010/01/01",
    "medicare_plan": "PART A",
    "medicare_reason": "AGE",
    "medicare_termination_date": "2009/01/01",
    "birthdate": "2007/07/08",
    "gender": "M",
    "relationship_code": "child",
    "qmcso": null,
    "lives_at_home": false,
    "address_1": "111 Lane Dr.",
    "address_2": "Apt. 21",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "34786",
    "country": "United States",
    "is_smoker": "NO",
    "verified": true,
    "verification_expires_on": "2009/01/01",
    "termination_date": "2018/01/04",
    "udef_1": "custom",
    "udef_2": "custom",
    "udef_3": "custom",
    "udef_4": "custom",
    "udef_5": "custom",
    "udef_6": "custom",
    "udef_7": "custom",
    "udef_8": "custom",
    "udef_9": "custom",
    "udef_10": "custom",
    "has_worksite_coverage": null,
    "anthem_member_code": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "The dependent cannot be terminated.  The dependent is already terminated.",
    "details": null,
    "error_code": 400
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "A termination_reason is required.  Please check the meta and pass the lookup_code in the termination_reason variable.",
    "details": null,
    "error_code": 404
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

subscriber_id
int64
required

The ID of the subscriber.

id
int64
required

The ID of the dependent to deactivate.

Query Params

is_custom_id
boolean

Set to true if the {subscriber_id} in the path is customer generated.

Body Params

termination_reason
string

Valid values are based on what is retrieved from meta resource.

Response

Dependent deactivate response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
public_idinteger
ssnstring
first_namestring
middle_namestring
last_namestring
name_suffixstring
hide_dependent_on_terminationboolean
org_relationship_idinteger
qmcso_benefitsstring
termination_reason_idstring
medicare_effective_datestring
medicare_planstring
medicare_reasonstring
medicare_termination_datestring
birthdatestring
genderstring
relationship_codestring
qmcsostring
lives_at_homeboolean
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
is_smokerstring
verifiedboolean
verification_expires_onstring
termination_datestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
has_worksite_coverageboolean
anthem_member_codestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscriber/{subscriber_id}/dependent/{id}/reactivate

Reactivate a dependent.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
puthttps://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id/reactivate
curl --request PUT \
  --url https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id/reactivate
var request = require("request");

var options = { method: 'PUT',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id/reactivate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id/reactivate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id/reactivate");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/dependent/id/reactivate"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12206082/dependent/2078210",
      "rel": "self"
    },
    "id": 2078210,
    "public_id": 2078210,
    "ssn": "XXX-XX-8782",
    "first_name": "TestFirst",
    "middle_name": "TestMiddle",
    "last_name": "TestLast",
    "name_suffix": "Mr.",
    "hide_dependent_on_termination": false,
    "qmcso_benefits": null,
    "termination_reason_id": 7,
    "medicare_effective_date": "2010/01/01",
    "medicare_plan": "PART A",
    "medicare_reason": "AGE",
    "medicare_termination_date": "2009/01/01",
    "birthdate": "2007/07/08",
    "gender": "M",
    "relationship_code": "child",
    "qmcso": null,
    "lives_at_home": false,
    "address_1": "111 Lane Dr.",
    "address_2": "Apt. 21",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "34786",
    "country": "United States",
    "is_smoker": "NO",
    "verified": true,
    "verification_expires_on": "2009/01/01",
    "termination_date": null,
    "udef_1": "custom",
    "udef_2": "custom",
    "udef_3": "custom",
    "udef_4": "custom",
    "udef_5": "custom",
    "udef_6": "custom",
    "udef_7": "custom",
    "udef_8": "custom",
    "udef_9": "custom",
    "udef_10": "custom",
    "has_worksite_coverage": null,
    "anthem_member_code": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "The dependent cannot be reactivated.  The dependent is already active.",
    "details": null,
    "error_code": 400
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'subscriber/8854530/dependent/2079234/reactivat' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

subscriber_id
int64
required

The ID of the subscriber.

id
int64
required

The ID of the dependent to reactivate.

Query Params

is_custom_id
boolean

Set to true if the {subscriber_id} in the path is customer generated.

Response

Dependent reactivate response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
public_idinteger
ssnstring
first_namestring
middle_namestring
last_namestring
name_suffixstring
hide_dependent_on_terminationboolean
org_relationship_idinteger
qmcso_benefitsstring
termination_reason_idstring
medicare_effective_datestring
medicare_planstring
medicare_reasonstring
medicare_termination_datestring
birthdatestring
genderstring
relationship_codestring
qmcsostring
lives_at_homeboolean
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
is_smokerstring
verifiedboolean
verification_expires_onstring
termination_datestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
has_worksite_coverageboolean
anthem_member_codestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/beneficiaries/meta

Retrieve meta data for beneficiaries.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
gethttps://partner-dev-api.plansource.com/admin/v2/beneficiaries/meta
curl --request GET \
  --url https://partner-dev-api.plansource.com/admin/v2/beneficiaries/meta
var request = require("request");

var options = { method: 'GET',
  url: 'https://partner-dev-api.plansource.com/admin/v2/beneficiaries/meta' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/beneficiaries/meta")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://partner-dev-api.plansource.com/admin/v2/beneficiaries/meta");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/beneficiaries/meta"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "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"
        },
        {
          "lookup_code": "divorce",
          "name": "Divorce (COBRA)",
          "description": "Spouse Divorced from employee"
        }
      ]
    }
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Requested route 'beneficiaries/met' not found",
    "details": null,
    "error_code": "route_not_found"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'beneficiarie/meta' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Response

List of meta data for beneficiaries.

statusstring
errorsarray
dataarray
termination_reasonarray

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/beneficiaries

Retrieve all beneficiaries for an organization.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
gethttps://partner-dev-api.plansource.com/admin/v2/beneficiaries
curl --request GET \
  --url https://partner-dev-api.plansource.com/admin/v2/beneficiaries
var request = require("request");

var options = { method: 'GET',
  url: 'https://partner-dev-api.plansource.com/admin/v2/beneficiaries' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/beneficiaries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://partner-dev-api.plansource.com/admin/v2/beneficiaries");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/beneficiaries"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "organization": {
      "links": {
        "href": "/admin/beneficiaries",
        "rel": "self"
      },
      "subscriber": {
        "links": {
          "href": "/admin/subscriber/8854530/beneficiaries",
          "rel": "self"
        },
        "beneficiaries": {
          "links": {
            "href": "/admin/coverage/20551170/beneficiaries",
            "rel": "self"
          },
          "id": 1640450,
          "coverage_line_id": null,
          "name": "Tony",
          "relationship": "Child",
          "allocation": "100.0",
          "primary_beneficiary": true,
          "address_1": null,
          "address_2": null,
          "city": null,
          "state": null,
          "country": null,
          "zip_code": null,
          "udef_1": null,
          "udef_2": null,
          "udef_3": null,
          "udef_4": null,
          "udef_5": null,
          "udef_6": null,
          "udef_7": null,
          "udef_8": null,
          "udef_9": null,
          "udef_10": null,
          "original_effective_date": "2018/05/29",
          "change_effective_date": "2018/05/29",
          "termination_date": null,
          "test_employee": false
        }
      }
    }
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Not enough or too many segments",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'beneficiarie' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Query Params

include_test
boolean

Include test employees.

Response

List of all beneficiaries.

statusstring
errorsstring
dataarray
organizationarray
linksarray
hrefstring
relstring
subscriberarray
beneficiariesarray
idinteger
coverage_line_idinteger
namestring
relationshipstring
allocationstring
primary_beneficiaryboolean
address_1string
address_2string
citystring
statestring
countrystring
zip_codestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
original_effective_datestring
change_effective_datestring
termination_datestring
test_employeeboolean

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscriber/{subscriber_id}/beneficiaries

Retrieve all beneficiaries for a subscriber.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
gethttps://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/beneficiaries
curl --request GET \
  --url https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/beneficiaries
var request = require("request");

var options = { method: 'GET',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/beneficiaries' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/beneficiaries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/beneficiaries");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscriber/subscriber_id/beneficiaries"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "subscriber": {
      "links": {
        "href": "/admin/subscriber/8854530/beneficiaries",
        "rel": "self"
      },
      "beneficiaries": {
        "links": {
          "href": "/admin/coverage/20551170/beneficiaries",
          "rel": "self"
        },
        "id": 1640450,
        "coverage_line_id": null,
        "name": "Tony",
        "relationship": "Child",
        "allocation": "100.0",
        "primary_beneficiary": true,
        "address_1": null,
        "address_2": null,
        "city": null,
        "state": null,
        "country": null,
        "zip_code": null,
        "udef_1": null,
        "udef_2": null,
        "udef_3": null,
        "udef_4": null,
        "udef_5": null,
        "udef_6": null,
        "udef_7": null,
        "udef_8": null,
        "udef_9": null,
        "udef_10": null,
        "original_effective_date": "2018/05/29",
        "change_effective_date": "2018/05/29",
        "termination_date": null
      }
    }
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Not enough or too many segments",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Invalid employee.  The employee id/code does not belong to the organization.",
    "details": null,
    "error_code": 404
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

subscriber_id
int64
required

The ID of the subscriber.

Query Params

is_custom_id
boolean

Set to true if the {subscriber_id} in the path is customer generated.

Response

Retrieved beneficiaries for a subscriber response.

statusstring
errorsarray
dataarray
subscriberarray
linksarray
hrefstring
relstring
beneficiariesarray
idinteger
coverage_line_idinteger
namestring
relationshipstring
allocationstring
primary_beneficiaryboolean
address_1string
address_2string
citystring
statestring
countrystring
zip_codestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
original_effective_datestring
change_effective_datestring
termination_datestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/coverage/{coverage_id}/beneficiaries

Retrieve all beneficiaries for a coverage.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
gethttps://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries
curl --request GET \
  --url https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries
var request = require("request");

var options = { method: 'GET',
  url: 'https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "beneficiaries": {
      "links": {
        "href": "/admin/coverage/20551170/beneficiaries",
        "rel": "self"
      },
      "id": 1640450,
      "coverage_line_id": null,
      "name": "Tony",
      "relationship": "Child",
      "allocation": "100.0",
      "primary_beneficiary": true,
      "address_1": null,
      "address_2": null,
      "city": null,
      "state": null,
      "country": null,
      "zip_code": null,
      "udef_1": null,
      "udef_2": null,
      "udef_3": null,
      "udef_4": null,
      "udef_5": null,
      "udef_6": null,
      "udef_7": null,
      "udef_8": null,
      "udef_9": null,
      "udef_10": null,
      "original_effective_date": "2018/05/29",
      "change_effective_date": "2018/05/29",
      "termination_date": null
    }
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Coverage not found for organization.",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'coverage/20551170/beneficiarie' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

coverage_id
int64
required

The ID of the coverage.

Response

Retrieved beneficiaries for a coverage response.

statusstring
errorsarray
dataarray
beneficiariesarray
linksarray
hrefstring
relstring
idinteger
coverage_line_idinteger
namestring
relationshipstring
allocationstring
primary_beneficiaryboolean
address_1string
address_2string
citystring
statestring
countrystring
zip_codestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
original_effective_datestring
change_effective_datestring
termination_datestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/coverage/{coverage_id}/beneficiaries

Update data for all beneficiaries for a coverage.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
puthttps://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries
curl --request PUT \
  --url https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries
var request = require("request");

var options = { method: 'PUT',
  url: 'https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "beneficiaries": {
      "links": {
        "href": "/admin/coverage/20551170/beneficiaries",
        "rel": "self"
      },
      "id": 1640450,
      "coverage_line_id": null,
      "name": "Hanks, Sally",
      "relationship": "Child",
      "allocation": "50.0",
      "primary_beneficiary": true,
      "address_1": "1111 Test St.",
      "address_2": null,
      "city": "Orlando",
      "state": "FL",
      "country": null,
      "zip_code": "32801",
      "udef_1": null,
      "udef_2": null,
      "udef_3": null,
      "udef_4": null,
      "udef_5": null,
      "udef_6": null,
      "udef_7": null,
      "udef_8": null,
      "udef_9": null,
      "udef_10": null,
      "original_effective_date": "2018/05/29",
      "change_effective_date": "2018/05/29",
      "termination_date": null
    }
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Invalid value for primary_beneficiary.  The valid values are YES,NO.",
    "details": null,
    "error_code": 400
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'coverage/20551170/beneficiarie' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

coverage_id
int64
required

The ID of the coverage.

Body Params

coverage_line_id
integer
name
string
relationship
string
allocation
string
primary_beneficiary
boolean
address_1
string
address_2
string
city
string
state
string
country
string
zip_code
string
udef_1
string
udef_2
string
udef_3
string
udef_4
string
udef_5
string
udef_6
string
udef_7
string
udef_8
string
udef_9
string
udef_10
string

Response

Beneficiaries update response.

statusstring
errorsarray
dataarray
beneficiariesarray
linksarray
hrefstring
relstring
idinteger
coverage_line_idinteger
namestring
relationshipstring
allocationstring
primary_beneficiaryboolean
address_1string
address_2string
citystring
statestring
countrystring
zip_codestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
original_effective_datestring
change_effective_datestring
termination_datestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/coverage/{coverage_id}/beneficiaries

Create beneficiary resources for a coverage.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
posthttps://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries
curl --request POST \
  --url https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries
var request = require("request");

var options = { method: 'POST',
  url: 'https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "beneficiaries": {
      "links": {
        "href": "/admin/coverage/20551170/beneficiaries",
        "rel": "self"
      },
      "id": 1976322,
      "coverage_line_id": null,
      "name": "Hanks, Tom",
      "relationship": "Child",
      "allocation": "50.0",
      "primary_beneficiary": true,
      "address_1": "1111 Test St.",
      "address_2": null,
      "city": "Orlando",
      "state": "FL",
      "country": null,
      "zip_code": "32801",
      "udef_1": null,
      "udef_2": null,
      "udef_3": null,
      "udef_4": null,
      "udef_5": null,
      "udef_6": null,
      "udef_7": null,
      "udef_8": null,
      "udef_9": null,
      "udef_10": null,
      "original_effective_date": "2018/05/29",
      "change_effective_date": "2018/05/29",
      "termination_date": null
    }
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Not enough or too many segments",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'coverage/20551170/beneficiarie' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

coverage_id
int64
required

The ID of the coverage.

Body Params

coverage_line_id
integer
name
string
relationship
string
allocation
string
primary_beneficiary
boolean
address_1
string
address_2
string
city
string
state
string
country
string
zip_code
string
udef_1
string
udef_2
string
udef_3
string
udef_4
string
udef_5
string
udef_6
string
udef_7
string
udef_8
string
udef_9
string
udef_10
string

Response

Multiple beneficiary create response.

statusstring
errorsarray
dataarray
beneficiariesarray
linksarray
hrefstring
relstring
idinteger
coverage_line_idinteger
namestring
relationshipstring
allocationstring
primary_beneficiaryboolean
address_1string
address_2string
citystring
statestring
countrystring
zip_codestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
original_effective_datestring
change_effective_datestring
termination_datestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/coverage/{coverage_id}/beneficiaries

Delete coverage beneficiaries.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
deletehttps://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries
curl --request DELETE \
  --url https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/coverage/coverage_id/beneficiaries"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "beneficiaries": {
      "links": {
        "href": "/admin/coverage/20551170/beneficiaries",
        "rel": "self"
      },
      "id": 1976322,
      "coverage_line_id": null,
      "name": "Hanks, Tom",
      "relationship": "Child",
      "allocation": "50.0",
      "primary_beneficiary": true,
      "address_1": "1111 Test St.",
      "address_2": null,
      "city": "Orlando",
      "state": "FL",
      "country": null,
      "zip_code": "32801",
      "udef_1": null,
      "udef_2": null,
      "udef_3": null,
      "udef_4": null,
      "udef_5": null,
      "udef_6": null,
      "udef_7": null,
      "udef_8": null,
      "udef_9": null,
      "udef_10": null,
      "original_effective_date": "2018/05/29",
      "change_effective_date": "2018/05/29",
      "termination_date": "2018/07/23"
    }
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Coverage not found for organization",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'coverage/20551170/beneficiarie' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

coverage_id
int64
required

The ID of the coverage.

Body Params

termination_date
string

Response

Multiple beneficiary delete response.

statusstring
errorsarray
dataarray
beneficiariesarray
linksarray
hrefstring
relstring
idinteger
coverage_line_idinteger
namestring
relationshipstring
allocationstring
primary_beneficiaryboolean
address_1string
address_2string
citystring
statestring
countrystring
zip_codestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
original_effective_datestring
change_effective_datestring
termination_datestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscribers

Create subscriber resources.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
posthttps://partner-dev-api.plansource.com/admin/v2/subscribers
curl --request POST \
  --url https://partner-dev-api.plansource.com/admin/v2/subscribers
var request = require("request");

var options = { method: 'POST',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscribers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscribers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://partner-dev-api.plansource.com/admin/v2/subscribers");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscribers"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12186626",
      "rel": "self"
    },
    "id": 12186626,
    "subscriber_code": null,
    "first_name": "John",
    "last_name": "Test",
    "middle_name": "M",
    "address_1": "1234TestSt.",
    "address_2": "",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "32801",
    "country": "United States",
    "home_phone": "4071231234",
    "work_phone": "4071231234",
    "cell_phone": "4071231234",
    "gender": "M",
    "hire_date": "2006/06/13",
    "birthdate": "1990/03/11",
    "ssn": null,
    "original_effective_date": null,
    "change_effective_date": null,
    "termination_date": null,
    "union_code": "HR",
    "employment_level": null,
    "pay_rate": "40.0",
    "pay_type": null,
    "org_payroll_id": "563",
    "employee_number": "2",
    "public_id": 988618,
    "marital_status": "M",
    "division": "A",
    "location": "FLORIDA",
    "org_class": "HOURLY",
    "business_title": "MR",
    "udef_1": null,
    "udef_2": null,
    "udef_3": null,
    "udef_4": null,
    "udef_5": null,
    "udef_6": null,
    "udef_7": null,
    "udef_8": null,
    "udef_9": null,
    "udef_10": null,
    "udef_11": null,
    "udef_12": null,
    "udef_13": null,
    "udef_14": null,
    "udef_15": null,
    "udef_16": null,
    "udef_17": null,
    "udef_18": null,
    "udef_19": null,
    "udef_20": null,
    "ee_code": null,
    "benefit_company": null,
    "original_hire_date": "2006/06/13",
    "seniority_date": null,
    "employment_status": null,
    "employment_status_starts_on": null,
    "employment_status_ends_on": null,
    "employee_type": null,
    "current_salary_effective_on": "2006/06/13",
    "current_salary": "70000.0",
    "benefit_deduction_group": null,
    "highly_compensated": null,
    "vip": null,
    "fmla": null,
    "name_suffix": null,
    "subscriber_status_id": 15,
    "status_changed_at": "2006/06/1300: 00: 00-0400",
    "status_starts_on": "2006/06/13",
    "status_ends_on": null,
    "benefits_start_date": "2006/06/13",
    "benefits_end_date": null,
    "parent_dependent_id": null,
    "status_ends_on_expected": null,
    "subscriber_status_subtype_id": null,
    "org_admin_enroll_reason_id": null,
    "test_employee": false,
    "is_voluntary_termination": false,
    "hide_from_payroll": false,
    "termination_reason_id": null,
    "bank_account_type": null,
    "ssn_exported": false,
    "eligible_org_population_ids": null,
    "shareholder": false,
    "owner": false,
    "anthem_hcid": null,
    "anthem_member_code": null,
    "written_language": null,
    "spoken_language": null,
    "exclude_from_batch_import": false,
    "anthem_sub_id": null,
    "hours_per_week": null,
    "medicare_reason": null,
    "medicare_plan": null,
    "medicare_effective_date": null,
    "medicare_termination_date": null,
    "is_smoker": null,
    "anthem_emp_dept_code": null,
    "county": null,
    "udef_21": null,
    "udef_22": null,
    "udef_23": null,
    "udef_24": null,
    "udef_25": null,
    "udef_26": null,
    "udef_27": null,
    "udef_28": null,
    "udef_29": null,
    "udef_30": null,
    "is_aca_full_time_for_enrollment": null,
    "email": null,
    "user_name": "jtest_7",
    "email2": null,
    "locked_at": null,
    "attempted_logon_count": 0,
    "disabled_on": null,
    "preferred_locale": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Invalid value for employee_number.  The valid values are '',1,2,3.",
    "details": null,
    "error_code": 400
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'subscribe' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Query Params

is_custom_id
boolean

Set to true if the {id} in the path is customer generated.

Body Params

subscriber_code
string
first_name
string
last_name
string
middle_name
string
address_1
string
address_2
string
city
string
state
string

Valid values are based on what is retrieved from meta resource.

zip_code
string
country
string

Valid values are based on what is retrieved from meta resource.

home_phone
string
work_phone
string
cell_phone
string
gender
string

Valid values are based on what is retrieved from meta resource.

hire_date
string

YYYY-MM-DD date format.

birthdate
string

YYYY-MM-DD date format.

ssn
string
original_effective_date
string

YYYY-MM-DD date format.

change_effective_date
string

YYYY-MM-DD date format.

termination_date
string

YYYY-MM-DD date format.

union_code
string
employment_level
string

Valid values are based on what is retrieved from meta resource.

pay_rate
string
pay_type
string
org_payroll_id
string

Valid values are based on what is retrieved from meta resource.

employee_number
string
public_id
string
marital_status
string

Valid values are based on what is retrieved from meta resource.

division
string
location
string
org_class
string
business_title
string
udef_1
string
udef_2
string
udef_3
string
udef_4
string
udef_5
string
udef_6
string
udef_7
string
udef_8
string
udef_9
string
udef_10
string
udef_11
string
udef_12
string
udef_13
string
udef_14
string
udef_15
string
udef_16
string
udef_17
string
udef_18
string
udef_19
string
udef_20
string
ee_code
string
benefit_company
string
original_hire_date
string

YYYY-MM-DD date format.

seniority_date
string

YYYY-MM-DD date format.

employment_status
string
employment_status_starts_on
string
employment_status_ends_on
string
employee_type
string
current_salary_effective_on
string

YYYY-MM-DD date format.

current_salary
string
benefit_deduction_group
string
highly_compensated
boolean
vip
boolean
fmla
boolean
name_suffix
string
subscriber_status_id
string
status_changed_at
string

YYYY-MM-DD date format.

status_starts_on
string

YYYY-MM-DD date format.

status_ends_on
string

YYYY-MM-DD date format.

benefits_start_date
string

YYYY-MM-DD date format.

benefits_end_date
string

YYYY-MM-DD date format.

parent_dependent_id
string
status_ends_on_expected
string

YYYY-MM-DD date format.

subscriber_status_subtype_id
string
test_employee
boolean
is_voluntary_termination
boolean
hide_from_payroll
boolean
termination_reason_id
string
bank_account_type
string
ssn_exported
boolean
eligible_org_population_ids
string
shareholder
boolean
owner
boolean
anthem_hcid
string
anthem_member_code
string
written_language
string

Valid values are based on what is retrieved from meta resource.

spoken_language
string

Valid values are based on what is retrieved from meta resource.

exclude_from_batch_import
boolean
anthem_sub_id
string
hours_per_week
string
medicare_reason
string

Valid values are based on what is retrieved from meta resource.

medicare_plan
string

Valid values are based on what is retrieved from meta resource.

medicare_effective_date
string

YYYY-MM-DD date format.

medicare_termination_date
string

YYYY-MM-DD date format.

is_smoker
string

Valid values are based on what is retrieved from meta resource.

anthem_emp_dept_code
string

Valid values are based on what is retrieved from meta resource.

county
string
udef_21
string
udef_22
string
udef_23
string
udef_24
string
udef_25
string
udef_26
string
udef_27
string
udef_28
string
udef_29
string
udef_30
string
email
string
user_name
string
email2
string
locked_at
string
attempted_logon_count
string
disabled_on
string
preferred_locale
string

Response

Multiple subscriber create response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
subscriber_codestring
first_namestring
last_namestring
middle_namestring
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
home_phonestring
work_phonestring
cell_phonestring
genderstring
hire_datestring
birthdatestring
ssnstring
original_effective_datestring
change_effective_datestring
termination_datestring
union_codestring
employment_levelstring
pay_ratestring
pay_typestring
org_payroll_idinteger
employee_numberstring
public_idinteger
marital_statusstring
divisionstring
locationstring
org_classstring
business_titlestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
udef_11string
udef_12string
udef_13string
udef_14string
udef_15string
udef_16string
udef_17string
udef_18string
udef_19string
udef_20string
ee_codestring
benefit_companystring
original_hire_datestring
seniority_datestring
employment_statusstring
employment_status_starts_onstring
employment_status_ends_onstring
employee_typestring
current_salary_effective_onstring
current_salarystring
benefit_deduction_groupstring
highly_compensatedstring
vipstring
fmlastring
name_suffixstring
subscriber_status_idstring
status_changed_atstring
status_starts_onstring
status_ends_onstring
benefits_start_datestring
benefits_end_datestring
parent_dependent_idstring
status_ends_on_expectedstring
subscriber_status_subtype_idstring
org_admin_enroll_reason_idstring
test_employeeboolean
is_voluntary_terminationstring
hide_from_payrollstring
termination_reason_idstring
bank_account_typestring
ssn_exportedboolean
eligible_org_population_idsstring
shareholderstring
ownerstring
anthem_hcidstring
anthem_member_codestring
written_languagestring
spoken_languagestring
exclude_from_batch_importstring
anthem_sub_idstring
hours_per_weekstring
medicare_reasonstring
medicare_planstring
medicare_effective_datestring
medicare_termination_datestring
is_smokerstring
anthem_emp_dept_codestring
countystring
udef_21string
udef_22string
udef_23string
udef_24string
udef_25string
udef_26string
udef_27string
udef_28string
udef_29string
udef_30string
is_aca_full_time_for_enrollmentstring
emailstring
user_namestring
email2string
locked_atstring
attemtped_logon_countinteger
disabled_onstring
preferred_localestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscribers

Retrieve data for all subscribers.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
gethttps://partner-dev-api.plansource.com/admin/v2/subscribers
curl --request GET \
  --url https://partner-dev-api.plansource.com/admin/v2/subscribers
var request = require("request");

var options = { method: 'GET',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscribers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscribers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://partner-dev-api.plansource.com/admin/v2/subscribers");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscribers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12186626",
      "rel": "self"
    },
    "id": 12186626,
    "subscriber_code": null,
    "first_name": "John",
    "last_name": "Test",
    "middle_name": "M",
    "address_1": "1234TestSt.",
    "address_2": "",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "32801",
    "country": "United States",
    "home_phone": "4071231234",
    "work_phone": "4071231234",
    "cell_phone": "4071231234",
    "gender": "M",
    "hire_date": "2006/06/13",
    "birthdate": "1990/03/11",
    "ssn": null,
    "original_effective_date": null,
    "change_effective_date": null,
    "termination_date": null,
    "union_code": "HR",
    "employment_level": null,
    "pay_rate": "40.0",
    "pay_type": null,
    "org_payroll_id": "563",
    "employee_number": "2",
    "public_id": 988618,
    "marital_status": "M",
    "division": "A",
    "location": "FLORIDA",
    "org_class": "HOURLY",
    "business_title": "MR",
    "udef_1": null,
    "udef_2": null,
    "udef_3": null,
    "udef_4": null,
    "udef_5": null,
    "udef_6": null,
    "udef_7": null,
    "udef_8": null,
    "udef_9": null,
    "udef_10": null,
    "udef_11": null,
    "udef_12": null,
    "udef_13": null,
    "udef_14": null,
    "udef_15": null,
    "udef_16": null,
    "udef_17": null,
    "udef_18": null,
    "udef_19": null,
    "udef_20": null,
    "ee_code": null,
    "benefit_company": null,
    "original_hire_date": "2006/06/13",
    "seniority_date": null,
    "employment_status": null,
    "employment_status_starts_on": null,
    "employment_status_ends_on": null,
    "employee_type": null,
    "current_salary_effective_on": "2006/06/13",
    "current_salary": "70000.0",
    "benefit_deduction_group": null,
    "highly_compensated": null,
    "vip": null,
    "fmla": null,
    "name_suffix": null,
    "subscriber_status_id": 15,
    "status_changed_at": "2006/06/1300: 00: 00-0400",
    "status_starts_on": "2006/06/13",
    "status_ends_on": null,
    "benefits_start_date": "2006/06/13",
    "benefits_end_date": null,
    "parent_dependent_id": null,
    "status_ends_on_expected": null,
    "subscriber_status_subtype_id": null,
    "org_admin_enroll_reason_id": null,
    "test_employee": false,
    "is_voluntary_termination": false,
    "hide_from_payroll": false,
    "termination_reason_id": null,
    "bank_account_type": null,
    "ssn_exported": false,
    "eligible_org_population_ids": null,
    "shareholder": false,
    "owner": false,
    "anthem_hcid": null,
    "anthem_member_code": null,
    "written_language": null,
    "spoken_language": null,
    "exclude_from_batch_import": false,
    "anthem_sub_id": null,
    "hours_per_week": null,
    "medicare_reason": null,
    "medicare_plan": null,
    "medicare_effective_date": null,
    "medicare_termination_date": null,
    "is_smoker": null,
    "anthem_emp_dept_code": null,
    "county": null,
    "udef_21": null,
    "udef_22": null,
    "udef_23": null,
    "udef_24": null,
    "udef_25": null,
    "udef_26": null,
    "udef_27": null,
    "udef_28": null,
    "udef_29": null,
    "udef_30": null,
    "is_aca_full_time_for_enrollment": null,
    "email": null,
    "user_name": "jtest_7",
    "email2": null,
    "locked_at": null,
    "attempted_logon_count": 0,
    "disabled_on": null,
    "preferred_locale": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Not enough or too many segments",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'subscribe' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Query Params

is_custom_id
boolean

Set to true if the {id} in the path is customer generated.

page
integer

Set to page number. Large responses are parsed into a maximum of 500 subscribers or the per_page value for large responses of subscribers.

per_page
integer

Override of the maximum of 500 subscribers returned in a response.

include_test
boolean

Include test employees.

Response

Multiple subscriber retrieval response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
subscriber_codestring
first_namestring
last_namestring
middle_namestring
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
home_phonestring
work_phonestring
cell_phonestring
genderstring
hire_datestring
birthdatestring
ssnstring
original_effective_datestring
change_effective_datestring
termination_datestring
union_codestring
employment_levelstring
pay_ratestring
pay_typestring
org_payroll_idinteger
employee_numberstring
public_idinteger
marital_statusstring
divisionstring
locationstring
org_classstring
business_titlestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
udef_11string
udef_12string
udef_13string
udef_14string
udef_15string
udef_16string
udef_17string
udef_18string
udef_19string
udef_20string
ee_codestring
benefit_companystring
original_hire_datestring
seniority_datestring
employment_statusstring
employment_status_starts_onstring
employment_status_ends_onstring
employee_typestring
current_salary_effective_onstring
current_salarystring
benefit_deduction_groupstring
highly_compensatedstring
vipstring
fmlastring
name_suffixstring
subscriber_status_idstring
status_changed_atstring
status_starts_onstring
status_ends_onstring
benefits_start_datestring
benefits_end_datestring
parent_dependent_idstring
status_ends_on_expectedstring
subscriber_status_subtype_idstring
org_admin_enroll_reason_idstring
test_employeeboolean
is_voluntary_terminationstring
hide_from_payrollstring
termination_reason_idstring
bank_account_typestring
ssn_exportedboolean
eligible_org_population_idsstring
shareholderstring
ownerstring
anthem_hcidstring
anthem_member_codestring
written_languagestring
spoken_languagestring
exclude_from_batch_importstring
anthem_sub_idstring
hours_per_weekstring
medicare_reasonstring
medicare_planstring
medicare_effective_datestring
medicare_termination_datestring
is_smokerstring
anthem_emp_dept_codestring
countystring
udef_21string
udef_22string
udef_23string
udef_24string
udef_25string
udef_26string
udef_27string
udef_28string
udef_29string
udef_30string
is_aca_full_time_for_enrollmentstring
emailstring
user_namestring
email2string
locked_atstring
attemtped_logon_countinteger
disabled_onstring
preferred_localestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscribers

Update data for all subscribers.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
puthttps://partner-dev-api.plansource.com/admin/v2/subscribers
curl --request PUT \
  --url https://partner-dev-api.plansource.com/admin/v2/subscribers
var request = require("request");

var options = { method: 'PUT',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscribers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscribers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://partner-dev-api.plansource.com/admin/v2/subscribers");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscribers"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12186626",
      "rel": "self"
    },
    "id": 12186626,
    "subscriber_code": null,
    "first_name": "John",
    "last_name": "Test",
    "middle_name": "M",
    "address_1": "1234TestSt.",
    "address_2": "",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "32801",
    "country": "United States",
    "home_phone": "4071231234",
    "work_phone": "4071231234",
    "cell_phone": "4071231234",
    "gender": "M",
    "hire_date": "2006/06/13",
    "birthdate": "1990/03/11",
    "ssn": null,
    "original_effective_date": null,
    "change_effective_date": null,
    "termination_date": null,
    "union_code": "HR",
    "employment_level": null,
    "pay_rate": "40.0",
    "pay_type": null,
    "org_payroll_id": "563",
    "employee_number": "2",
    "public_id": 988618,
    "marital_status": "M",
    "division": "A",
    "location": "FLORIDA",
    "org_class": "HOURLY",
    "business_title": "MR",
    "udef_1": null,
    "udef_2": null,
    "udef_3": null,
    "udef_4": null,
    "udef_5": null,
    "udef_6": null,
    "udef_7": null,
    "udef_8": null,
    "udef_9": null,
    "udef_10": null,
    "udef_11": null,
    "udef_12": null,
    "udef_13": null,
    "udef_14": null,
    "udef_15": null,
    "udef_16": null,
    "udef_17": null,
    "udef_18": null,
    "udef_19": null,
    "udef_20": null,
    "ee_code": null,
    "benefit_company": null,
    "original_hire_date": "2006/06/13",
    "seniority_date": null,
    "employment_status": null,
    "employment_status_starts_on": null,
    "employment_status_ends_on": null,
    "employee_type": null,
    "current_salary_effective_on": "2006/06/13",
    "current_salary": "70000.0",
    "benefit_deduction_group": null,
    "highly_compensated": null,
    "vip": null,
    "fmla": null,
    "name_suffix": null,
    "subscriber_status_id": 15,
    "status_changed_at": "2006/06/1300: 00: 00-0400",
    "status_starts_on": "2006/06/13",
    "status_ends_on": null,
    "benefits_start_date": "2006/06/13",
    "benefits_end_date": null,
    "parent_dependent_id": null,
    "status_ends_on_expected": null,
    "subscriber_status_subtype_id": null,
    "org_admin_enroll_reason_id": null,
    "test_employee": false,
    "is_voluntary_termination": false,
    "hide_from_payroll": false,
    "termination_reason_id": null,
    "bank_account_type": null,
    "ssn_exported": false,
    "eligible_org_population_ids": null,
    "shareholder": false,
    "owner": false,
    "anthem_hcid": null,
    "anthem_member_code": null,
    "written_language": null,
    "spoken_language": null,
    "exclude_from_batch_import": false,
    "anthem_sub_id": null,
    "hours_per_week": null,
    "medicare_reason": null,
    "medicare_plan": null,
    "medicare_effective_date": null,
    "medicare_termination_date": null,
    "is_smoker": null,
    "anthem_emp_dept_code": null,
    "county": null,
    "udef_21": null,
    "udef_22": null,
    "udef_23": null,
    "udef_24": null,
    "udef_25": null,
    "udef_26": null,
    "udef_27": null,
    "udef_28": null,
    "udef_29": null,
    "udef_30": null,
    "is_aca_full_time_for_enrollment": null,
    "email": null,
    "user_name": "jtest_7",
    "email2": null,
    "locked_at": null,
    "attempted_logon_count": 0,
    "disabled_on": null,
    "preferred_locale": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "undefined method `+' for #<NoMethodError: undefined method `gsub' for nil:NilClass>",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'subscriber' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Query Params

is_custom_id
boolean

Set to true if the {id} is customer generated.

Body Params

id
string
subscriber_code
string
first_name
string
last_name
string
middle_name
string
address_1
string
address_2
string
city
string
state
string

Valid values are based on what is retrieved from meta resource.

zip_code
string
country
string

Valid values are based on what is retrieved from meta resource.

home_phone
string
work_phone
string
cell_phone
string
gender
string

Valid values are based on what is retrieved from meta resource.

hire_date
string

YYYY-MM-DD date format.

birthdate
string

YYYY-MM-DD date format.

ssn
string
original_effective_date
string

YYYY-MM-DD date format.

change_effective_date
string

YYYY-MM-DD date format.

termination_date
string

YYYY-MM-DD date format.

union_code
string
employment_level
string

Valid values are based on what is retrieved from meta resource.

pay_rate
string
pay_type
string
org_payroll_id
string

Valid values are based on what is retrieved from meta resource.

employee_number
string
public_id
string
marital_status
string

Valid values are based on what is retrieved from meta resource.

division
string
location
string
org_class
string
business_title
string
udef_1
string
udef_2
string
udef_3
string
udef_4
string
udef_5
string
udef_6
string
udef_7
string
udef_8
string
udef_9
string
udef_10
string
udef_11
string
udef_12
string
udef_13
string
udef_14
string
udef_15
string
udef_16
string
udef_17
string
udef_18
string
udef_19
string
udef_20
string
ee_code
string
benefit_company
string
original_hire_date
string

YYYY-MM-DD date format.

seniority_date
string

YYYY-MM-DD date format.

employment_status
string
employment_status_starts_on
string
employment_status_ends_on
string
employee_type
string
current_salary_effective_on
string

YYYY-MM-DD date format.

current_salary
string
benefit_deduction_group
string
highly_compensated
boolean
vip
boolean
fmla
boolean
name_suffix
string
subscriber_status_id
string
status_changed_at
string

YYYY-MM-DD date format.

status_starts_on
string

YYYY-MM-DD date format.

status_ends_on
string

YYYY-MM-DD date format.

benefits_start_date
string

YYYY-MM-DD date format.

benefits_end_date
string

YYYY-MM-DD date format.

parent_dependent_id
string
status_ends_on_expected
string

YYYY-MM-DD date format.

subscriber_status_subtype_id
string
test_employee
boolean
is_voluntary_termination
boolean
hide_from_payroll
boolean
termination_reason_id
string
bank_account_type
string
ssn_exported
boolean
eligible_org_population_ids
string
shareholder
boolean
owner
boolean
anthem_hcid
string
anthem_member_code
string
written_language
string

Valid values are based on what is retrieved from meta resource.

spoken_language
string

Valid values are based on what is retrieved from meta resource.

exclude_from_batch_import
boolean
anthem_sub_id
string
hours_per_week
string
medicare_reason
string

Valid values are based on what is retrieved from meta resource.

medicare_plan
string

Valid values are based on what is retrieved from meta resource.

medicare_effective_date
string

YYYY-MM-DD date format.

medicare_termination_date
string

YYYY-MM-DD date format.

is_smoker
string

Valid values are based on what is retrieved from meta resource.

anthem_emp_dept_code
string

Valid values are based on what is retrieved from meta resource.

county
string
udef_21
string
udef_22
string
udef_23
string
udef_24
string
udef_25
string
udef_26
string
udef_27
string
udef_28
string
udef_29
string
udef_30
string
email
string
user_name
string
email2
string
locked_at
string
attempted_logon_count
string
disabled_on
string
preferred_locale
string

Response

Subscribers update response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
subscriber_codestring
first_namestring
last_namestring
middle_namestring
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
home_phonestring
work_phonestring
cell_phonestring
genderstring
hire_datestring
birthdatestring
ssnstring
original_effective_datestring
change_effective_datestring
termination_datestring
union_codestring
employment_levelstring
pay_ratestring
pay_typestring
org_payroll_idinteger
employee_numberstring
public_idinteger
marital_statusstring
divisionstring
locationstring
org_classstring
business_titlestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
udef_11string
udef_12string
udef_13string
udef_14string
udef_15string
udef_16string
udef_17string
udef_18string
udef_19string
udef_20string
ee_codestring
benefit_companystring
original_hire_datestring
seniority_datestring
employment_statusstring
employment_status_starts_onstring
employment_status_ends_onstring
employee_typestring
current_salary_effective_onstring
current_salarystring
benefit_deduction_groupstring
highly_compensatedstring
vipstring
fmlastring
name_suffixstring
subscriber_status_idstring
status_changed_atstring
status_starts_onstring
status_ends_onstring
benefits_start_datestring
benefits_end_datestring
parent_dependent_idstring
status_ends_on_expectedstring
subscriber_status_subtype_idstring
org_admin_enroll_reason_idstring
test_employeeboolean
is_voluntary_terminationstring
hide_from_payrollstring
termination_reason_idstring
bank_account_typestring
ssn_exportedboolean
eligible_org_population_idsstring
shareholderstring
ownerstring
anthem_hcidstring
anthem_member_codestring
written_languagestring
spoken_languagestring
exclude_from_batch_importstring
anthem_sub_idstring
hours_per_weekstring
medicare_reasonstring
medicare_planstring
medicare_effective_datestring
medicare_termination_datestring
is_smokerstring
anthem_emp_dept_codestring
countystring
udef_21string
udef_22string
udef_23string
udef_24string
udef_25string
udef_26string
udef_27string
udef_28string
udef_29string
udef_30string
is_aca_full_time_for_enrollmentstring
emailstring
user_namestring
email2string
locked_atstring
attemtped_logon_countinteger
disabled_onstring
preferred_localestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscribers/terminate

Terminate subscriber resources.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
puthttps://partner-dev-api.plansource.com/admin/v2/subscribers/terminate
curl --request PUT \
  --url https://partner-dev-api.plansource.com/admin/v2/subscribers/terminate
var request = require("request");

var options = { method: 'PUT',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscribers/terminate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscribers/terminate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://partner-dev-api.plansource.com/admin/v2/subscribers/terminate");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscribers/terminate"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12186626",
      "rel": "self"
    },
    "id": 12186626,
    "subscriber_code": null,
    "first_name": "John",
    "last_name": "Test",
    "middle_name": "M",
    "address_1": "1234TestSt.",
    "address_2": "",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "32801",
    "country": "United States",
    "home_phone": "4071231234",
    "work_phone": "4071231234",
    "cell_phone": "4071231234",
    "gender": "M",
    "hire_date": "2006/06/13",
    "birthdate": "1990/03/11",
    "ssn": null,
    "original_effective_date": null,
    "change_effective_date": null,
    "termination_date": "2018/04/13",
    "union_code": "HR",
    "employment_level": null,
    "pay_rate": "40.0",
    "pay_type": null,
    "org_payroll_id": "563",
    "employee_number": "2",
    "public_id": 988618,
    "marital_status": "M",
    "division": "A",
    "location": "FLORIDA",
    "org_class": "HOURLY",
    "business_title": "MR",
    "udef_1": null,
    "udef_2": null,
    "udef_3": null,
    "udef_4": null,
    "udef_5": null,
    "udef_6": null,
    "udef_7": null,
    "udef_8": null,
    "udef_9": null,
    "udef_10": null,
    "udef_11": null,
    "udef_12": null,
    "udef_13": null,
    "udef_14": null,
    "udef_15": null,
    "udef_16": null,
    "udef_17": null,
    "udef_18": null,
    "udef_19": null,
    "udef_20": null,
    "ee_code": null,
    "benefit_company": null,
    "original_hire_date": "2006/06/13",
    "seniority_date": null,
    "employment_status": null,
    "employment_status_starts_on": null,
    "employment_status_ends_on": null,
    "employee_type": null,
    "current_salary_effective_on": "2006/06/13",
    "current_salary": "70000.0",
    "benefit_deduction_group": null,
    "highly_compensated": null,
    "vip": null,
    "fmla": null,
    "name_suffix": null,
    "subscriber_status_id": 15,
    "status_changed_at": "2006/06/1300: 00: 00-0400",
    "status_starts_on": "2006/06/13",
    "status_ends_on": null,
    "benefits_start_date": "2006/06/13",
    "benefits_end_date": null,
    "parent_dependent_id": null,
    "status_ends_on_expected": null,
    "subscriber_status_subtype_id": null,
    "org_admin_enroll_reason_id": null,
    "test_employee": false,
    "is_voluntary_termination": true,
    "hide_from_payroll": false,
    "termination_reason_id": 4,
    "bank_account_type": null,
    "ssn_exported": false,
    "eligible_org_population_ids": null,
    "shareholder": false,
    "owner": false,
    "anthem_hcid": null,
    "anthem_member_code": null,
    "written_language": null,
    "spoken_language": null,
    "exclude_from_batch_import": false,
    "anthem_sub_id": null,
    "hours_per_week": null,
    "medicare_reason": null,
    "medicare_plan": null,
    "medicare_effective_date": null,
    "medicare_termination_date": null,
    "is_smoker": null,
    "anthem_emp_dept_code": null,
    "county": null,
    "udef_21": null,
    "udef_22": null,
    "udef_23": null,
    "udef_24": null,
    "udef_25": null,
    "udef_26": null,
    "udef_27": null,
    "udef_28": null,
    "udef_29": null,
    "udef_30": null,
    "is_aca_full_time_for_enrollment": null,
    "email": null,
    "user_name": "jtest_7",
    "email2": null,
    "locked_at": null,
    "attempted_logon_count": 0,
    "disabled_on": null,
    "preferred_locale": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Cannot perform action as the employee is terminated",
    "details": null,
    "error_code": 400
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'subscribers/terminat' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Query Params

is_custom_id
boolean

Set to true if the {id} is customer generated.

Body Params

id
string
termination_reason
string

Valid values are based on what is retrieved from meta resource.

termination_date
string

YYYY-MM-DD date format.

volunatary
boolean

Response

Subscribers terminate response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
subscriber_codestring
first_namestring
last_namestring
middle_namestring
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
home_phonestring
work_phonestring
cell_phonestring
genderstring
hire_datestring
birthdatestring
ssnstring
original_effective_datestring
change_effective_datestring
termination_datestring
union_codestring
employment_levelstring
pay_ratestring
pay_typestring
org_payroll_idinteger
employee_numberstring
public_idinteger
marital_statusstring
divisionstring
locationstring
org_classstring
business_titlestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
udef_11string
udef_12string
udef_13string
udef_14string
udef_15string
udef_16string
udef_17string
udef_18string
udef_19string
udef_20string
ee_codestring
benefit_companystring
original_hire_datestring
seniority_datestring
employment_statusstring
employment_status_starts_onstring
employment_status_ends_onstring
employee_typestring
current_salary_effective_onstring
current_salarystring
benefit_deduction_groupstring
highly_compensatedstring
vipstring
fmlastring
name_suffixstring
subscriber_status_idstring
status_changed_atstring
status_starts_onstring
status_ends_onstring
benefits_start_datestring
benefits_end_datestring
parent_dependent_idstring
status_ends_on_expectedstring
subscriber_status_subtype_idstring
org_admin_enroll_reason_idstring
test_employeeboolean
is_voluntary_terminationstring
hide_from_payrollstring
termination_reason_idstring
bank_account_typestring
ssn_exportedboolean
eligible_org_population_idsstring
shareholderstring
ownerstring
anthem_hcidstring
anthem_member_codestring
written_languagestring
spoken_languagestring
exclude_from_batch_importstring
anthem_sub_idstring
hours_per_weekstring
medicare_reasonstring
medicare_planstring
medicare_effective_datestring
medicare_termination_datestring
is_smokerstring
anthem_emp_dept_codestring
countystring
udef_21string
udef_22string
udef_23string
udef_24string
udef_25string
udef_26string
udef_27string
udef_28string
udef_29string
udef_30string
is_aca_full_time_for_enrollmentstring
emailstring
user_namestring
email2string
locked_atstring
attemtped_logon_countinteger
disabled_onstring
preferred_localestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/subscribers/rehire

Rehire subscriber resources.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
puthttps://partner-dev-api.plansource.com/admin/v2/subscribers/rehire
curl --request PUT \
  --url https://partner-dev-api.plansource.com/admin/v2/subscribers/rehire
var request = require("request");

var options = { method: 'PUT',
  url: 'https://partner-dev-api.plansource.com/admin/v2/subscribers/rehire' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/subscribers/rehire")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://partner-dev-api.plansource.com/admin/v2/subscribers/rehire");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/subscribers/rehire"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "links": {
      "href": "/admin/subscriber/12186626",
      "rel": "self"
    },
    "id": 12186626,
    "subscriber_code": null,
    "first_name": "John",
    "last_name": "Test",
    "middle_name": "M",
    "address_1": "1234TestSt.",
    "address_2": "",
    "city": "Orlando",
    "state": "FL",
    "zip_code": "32801",
    "country": "United States",
    "home_phone": "4071231234",
    "work_phone": "4071231234",
    "cell_phone": "4071231234",
    "gender": "M",
    "hire_date": "2018/07/08",
    "birthdate": "1990/03/11",
    "ssn": null,
    "original_effective_date": null,
    "change_effective_date": null,
    "termination_date": null,
    "union_code": "HR",
    "employment_level": null,
    "pay_rate": "40.0",
    "pay_type": null,
    "org_payroll_id": "563",
    "employee_number": "2",
    "public_id": 988618,
    "marital_status": "M",
    "division": "A",
    "location": "FLORIDA",
    "org_class": "HOURLY",
    "business_title": "MR",
    "udef_1": null,
    "udef_2": null,
    "udef_3": null,
    "udef_4": null,
    "udef_5": null,
    "udef_6": null,
    "udef_7": null,
    "udef_8": null,
    "udef_9": null,
    "udef_10": null,
    "udef_11": null,
    "udef_12": null,
    "udef_13": null,
    "udef_14": null,
    "udef_15": null,
    "udef_16": null,
    "udef_17": null,
    "udef_18": null,
    "udef_19": null,
    "udef_20": null,
    "ee_code": null,
    "benefit_company": null,
    "original_hire_date": "2006/06/13",
    "seniority_date": null,
    "employment_status": null,
    "employment_status_starts_on": null,
    "employment_status_ends_on": null,
    "employee_type": null,
    "current_salary_effective_on": "2006/06/13",
    "current_salary": "70000.0",
    "benefit_deduction_group": null,
    "highly_compensated": null,
    "vip": null,
    "fmla": null,
    "name_suffix": null,
    "subscriber_status_id": 15,
    "status_changed_at": "2006/06/1300: 00: 00-0400",
    "status_starts_on": "2018/07/08",
    "status_ends_on": null,
    "benefits_start_date": "2018/07/08",
    "benefits_end_date": null,
    "parent_dependent_id": null,
    "status_ends_on_expected": null,
    "subscriber_status_subtype_id": null,
    "org_admin_enroll_reason_id": null,
    "test_employee": false,
    "is_voluntary_termination": false,
    "hide_from_payroll": false,
    "termination_reason_id": null,
    "bank_account_type": null,
    "ssn_exported": false,
    "eligible_org_population_ids": null,
    "shareholder": false,
    "owner": false,
    "anthem_hcid": null,
    "anthem_member_code": null,
    "written_language": null,
    "spoken_language": null,
    "exclude_from_batch_import": false,
    "anthem_sub_id": null,
    "hours_per_week": null,
    "medicare_reason": null,
    "medicare_plan": null,
    "medicare_effective_date": null,
    "medicare_termination_date": null,
    "is_smoker": null,
    "anthem_emp_dept_code": null,
    "county": null,
    "udef_21": null,
    "udef_22": null,
    "udef_23": null,
    "udef_24": null,
    "udef_25": null,
    "udef_26": null,
    "udef_27": null,
    "udef_28": null,
    "udef_29": null,
    "udef_30": null,
    "is_aca_full_time_for_enrollment": null,
    "email": null,
    "user_name": "jtest_7",
    "email2": null,
    "locked_at": null,
    "attempted_logon_count": 0,
    "disabled_on": null,
    "preferred_locale": null
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "Cannot perform action as the employee is not terminated",
    "details": null,
    "error_code": 400
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'subscribers/rehir' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Query Params

is_custom_id
boolean

Set to true if the {id} is customer generated.

Body Params

id
string
rehire_date

YYYY-MM-DD date format.

Response

Subscribers rehire response.

statusstring
errorsarray
dataarray
linksarray
hrefstring
relstring
idinteger
subscriber_codestring
first_namestring
last_namestring
middle_namestring
address_1string
address_2string
citystring
statestring
zip_codestring
countrystring
home_phonestring
work_phonestring
cell_phonestring
genderstring
hire_datestring
birthdatestring
ssnstring
original_effective_datestring
change_effective_datestring
termination_datestring
union_codestring
employment_levelstring
pay_ratestring
pay_typestring
org_payroll_idinteger
employee_numberstring
public_idinteger
marital_statusstring
divisionstring
locationstring
org_classstring
business_titlestring
udef_1string
udef_2string
udef_3string
udef_4string
udef_5string
udef_6string
udef_7string
udef_8string
udef_9string
udef_10string
udef_11string
udef_12string
udef_13string
udef_14string
udef_15string
udef_16string
udef_17string
udef_18string
udef_19string
udef_20string
ee_codestring
benefit_companystring
original_hire_datestring
seniority_datestring
employment_statusstring
employment_status_starts_onstring
employment_status_ends_onstring
employee_typestring
current_salary_effective_onstring
current_salarystring
benefit_deduction_groupstring
highly_compensatedstring
vipstring
fmlastring
name_suffixstring
subscriber_status_idstring
status_changed_atstring
status_starts_onstring
status_ends_onstring
benefits_start_datestring
benefits_end_datestring
parent_dependent_idstring
status_ends_on_expectedstring
subscriber_status_subtype_idstring
org_admin_enroll_reason_idstring
test_employeeboolean
is_voluntary_terminationstring
hide_from_payrollstring
termination_reason_idstring
bank_account_typestring
ssn_exportedboolean
eligible_org_population_idsstring
shareholderstring
ownerstring
anthem_hcidstring
anthem_member_codestring
written_languagestring
spoken_languagestring
exclude_from_batch_importstring
anthem_sub_idstring
hours_per_weekstring
medicare_reasonstring
medicare_planstring
medicare_effective_datestring
medicare_termination_datestring
is_smokerstring
anthem_emp_dept_codestring
countystring
udef_21string
udef_22string
udef_23string
udef_24string
udef_25string
udef_26string
udef_27string
udef_28string
udef_29string
udef_30string
is_aca_full_time_for_enrollmentstring
emailstring
user_namestring
email2string
locked_atstring
attemtped_logon_countinteger
disabled_onstring
preferred_localestring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Payroll

 

/payroll_coverages_subscriber/{id}

Retrieve payroll coverages for a subscriber.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
gethttps://partner-dev-api.plansource.com/admin/v2/payroll_coverages_subscriber/id
curl --request GET \
  --url 'https://partner-dev-api.plansource.com/admin/v2/payroll_coverages_subscriber/id?start_date=start_date&end_date=end_date'
var request = require("request");

var options = { method: 'GET',
  url: 'https://partner-dev-api.plansource.com/admin/v2/payroll_coverages_subscriber/id',
  qs: 
   { start_date: 'start_date',
     end_date: 'end_date' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://partner-dev-api.plansource.com/admin/v2/payroll_coverages_subscriber/id?start_date=start_date&end_date=end_date")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://partner-dev-api.plansource.com/admin/v2/payroll_coverages_subscriber/id?start_date=start_date&end_date=end_date");

xhr.send(data);
import requests

url = "https://partner-dev-api.plansource.com/admin/v2/payroll_coverages_subscriber/id"

querystring = {"start_date":"start_date","end_date":"end_date"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "status": "success",
  "errors": [],
  "data": {
    "id": 8854530,
    "subscriber_code": "",
    "first_name": "Ted",
    "middle_name": "M",
    "last_name": "Mosby",
    "ssn": "123-12-1234",
    "subscriber_status": null,
    "subscriber_pay_frequency": "Biweekly (26 per year)",
    "subscriber_total_paydays": 26,
    "organization_id": 652,
    "org_plan_year_starts": "2018/01/04",
    "org_plan_year_ends": "2019/01/03",
    "benefit_name": "Medical",
    "benefit_lookup_code": "medical",
    "plan_name": "Decline",
    "coverage_level": "Decline",
    "subscriber_premium": "0.0",
    "org_premium": "0.0",
    "imputed_income": "0.0",
    "subscriber_pretax_premium": "0.0",
    "subscriber_posttax_premium": "0.0",
    "tax_treatment": "posttax",
    "volume": "0.0",
    "org_fsa_amount": "0.0",
    "original_effective_date": "2018-01-04T00:00:00+00:00",
    "change_effective_date": "2018-01-04T00:00:00+00:00",
    "dp_sub_imputed_income": "0.0",
    "dp_org_imputed_income": "0.0",
    "plan_payroll_mapping_code": null,
    "plan_group_number": null,
    "plan_partner_code_1": null,
    "plan_partner_code_2": null,
    "current": "CA",
    "updated_at": "2018-05-29T19:59:55+00:00",
    "created_at": "2018-05-29T15:31:25+00:00",
    "termination_date": "2018/01/03",
    "termination_reason": "Subscriber voluntarily waived coverage"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 400,
    "message": "start_date date is not a valid YYYY-MM-DD date format.",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 401,
    "message": "Signature has expired",
    "details": null,
    "error_code": "invalid_token"
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 403,
    "message": "Forbidden",
    "details": null,
    "error_code": null
  },
  "data": []
}
{
  "status": "failure",
  "errors": {
    "http_status": 404,
    "message": "Requested route 'payroll_coverages_subscribr/8854530' not found",
    "details": null,
    "error_code": "route_not_found"
  }
}
{
  "status": "failure",
  "errors": {
    "http_status": 500,
    "message": "Internal error",
    "details": null,
    "error_code": null
  },
  "data": []
}

Path Params

id
int64
required

The ID of the subscriber.

Query Params

start_date
date
required

Start date of a date range of payroll changes. ISO 8601 date or RFC 3339 date time date (ex. 2017-12-01 or 2017-12-01T12:30:30-06:00).

end_date
date
required

End date of a date range of payroll changes. ISO 8601 date or RFC 3339 date time (ex. 2017-12-01 or 2017-12-01T12:30:30-06:00).

is_custom_id
boolean

Set to true if the {id} in the path is customer generated.

Response

Payroll coverages for a subscriber response.

statusstring
errorsarray
dataarray
idinteger
subscriber_codestring
first_namestring
middle_namestring
last_namestring
ssnstring
subscriber_statusstring
subscriber_pay_frequencystring
subscriber_total_paydaysinteger
organization_idinteger
org_plan_year_startsstring
org_plan_year_endsstring
benefit_namestring
benefit_lookup_codestring
plan_namestring
coverage_levelstring
subscriber_premiumstring
org_premiumstring
imputed_incomestring
subscriber_pretax_premiumstring
subscriber_posttax_premiumstring
tax_treatmentstring
volumestring
org_fsa_amountstring
original_effective_datestring
change_effective_datestring
dp_sub_imputed_incomestring
dp_org_imputed_incomestring
plan_payroll_mapping_codestring
plan_group_numberstring
plan_partner_code_1string
plan_partner_code_2string
currentstring
updated_atstring
created_atstring
termination_datestring
termination_reasonstring

Malformed request.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Invalid token.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Access error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

Resource not found.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring

Server error.

statusstring
errorsarray
http_statusinteger
messagestring
detailsstring
error_codestring
dataarray

/payroll_coverages_subscribers

Retrieve payroll coverages for all subscribers in the organization.

 

OAuth2 Auth

Bearer

Header Auth

 Authentication is required for this endpoint.
get