Listed below are the data fields that can be accessed for Administrators data using PlanSource's API. Each field is described as being "optional". That is because developers are not required to fill out every data field in order to make the API call. Although that is the case, PlanSource does require certain data fields to be entered in order to POST/PUT/GET Administrators data. What is required can be changed manually within the PlanSource Benefits Admin site by utilizing the Data Field Security configuration.
NOTE: Some of these fields are list validated fields. To learn what that means, visit the Guide on List Validated Fields.
User role object. Define fields and their values within this role object
Administrator role object. Define fields and their values within this role object
Administrator unique ID retrieved when making a GET call.
The administrator user type - organization administrator (org_admin) or master administrator (master_admin)
Master Org ID
Organization codes. List of one or more organization codes the administrator has access or belongs to
General Agency ID
Is Primary Administrator
Is Data Discrepancy Contact
Receive System Downtime Notifications
Receive System Release Notes
Receive Renewal Notifications
Receive Ticket Notifications
Data field security lookup code. Default value is update_all
Account Initialized. Either true or false
(within array populations) id
ID of population.
(within array populations) name
Name of population
Organization populations. List of one or more population codes is required if creating organization administrator
(within array roles) ID
ID of roles.
(within array roles) name
Name of roles