Administrators Fields

Administrators

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.

Administrators FieldsData TypesField Descriptions
userrole objectUser role object. Define fields and their values within this role object
administratorrole objectAdministrator role object. Define fields and their values within this role object
idintegerAdministrator unique ID retrieved when making a GET call.
typestringAdministrator Type
user_typestringThe administrator user type - organization administrator (org_admin) or master administrator (master_admin)
first_namestringFirst Name
middle_namestringMiddle Name
last_namestringLast Name
user_idintegerUser ID
phonestringPhone
master_org_idintegerMaster Org ID
organization_idintegerOrganization ID
organization_codesarrayOrganization codes. List of one or more organization codes the administrator has access or belongs to
is_agentbooleanIs Agent
carrier_idintegerCarrier ID
general_agency_idintegerGeneral Agency ID
faxstringFax
tax_idintegerTax ID
is_primary_administratorbooleanIs Primary Administrator
is_data_discrepancy_contactbooleanIs Data Discrepancy Contact
receive_system_downtime_notificationsbooleanReceive System Downtime Notifications
receive_system_release_notesbooleanReceive System Release Notes
receive_renewal_notificationsbooleanReceive Renewal Notifications
receive_ticket_notificationsbooleanReceive Ticket Notifications
far_lookup_codestringData field security lookup code. Default value is update_all
account_initializedbooleanAccount Initialized. Either true or false
populationsarrayPopulations
(within array populations) idintegerID of population.
(within array populations) namestringName of population
org_populationsarrayOrganization populations. List of one or more population codes is required if creating organization administrator
rolesarrayRoles
(within array roles) IDintegerID of roles.
(within array roles) namestringName of roles
user_namestringUser Name
emailstringEmail
email2stringEmail 2
namestringName
override_ssobooleanOverride SSO
time_zonestringTime zone