Locations

Detailed mapping of the fields used in secondary Locations - in POST, PUT, and GET requests

Use-case

The locations object is used when an employer has many work locations. Locations can either be created as a primary_locationon the group, or one of many secondary locationscreated using the POST to groups/{id}/locations.

This information is usually optional, but can be used to classify or divide employees. Uncommonly a carrier account structure could require divisions or subgroups to be assigned by work location.

If your system stores this information, it will be useful to implement to locationsand provide your team with the option of sending these locations when needed.

GET requests

• Since locations belong to a group, you can pull a set of the current locations by calling GET groups/{id}. Doing so provides a response with secondary_locations.

• Any location created using the POST to groups/{id}/locations would be returned in this groups response.

PUT requests

• Schema does not differ from the POST request below

POST requests

• Sending a call to groups/{id}/locations will create a new location and associate it with the provided group.

Required Elements

Ideon	Usage and Mapping
external_identifier	This is an identifier that your system can use or generate to identify the location. This is in addition to our id that we generate upon creation.
type	This is the specific type of location - physical or remote. When this value is remote, an address object is not required. Enumeration: physical remote
employer_address	This address element is required for all physical locations. The value follows the same address schema as our other addressobjects: Required address_line_1 city zip Recommended if present address_line_2 state fips_county_code country_code Note: Ideon currently only supports domestic addresses for enrollments, the country code can be defaulted to USA (as it will be if not provided)

Optional Elements

We ask you provide these values if available and consistent, as these can be very useful if carriers have questions or confirmations on a specific population or work location.

These elements are Optional

Ideon	Usage and Mapping
mailing_address	This is the mailing address for a given location, which can differ from the address provided on the employer_address object. The value follows the same address schema as our other addressobjects: Required address_line_1 city zip Recommended if present address_line_2 state fips_county_code country_code Note: Ideon currently only supports domestic addresses for enrollments, the country code can be defaulted to USA (as it will be if not provided)
benefit_administrator	This element contains contact information for a location-specific Benefit Administror. This person may be be used as a contact for benefit administration. Required first_name last_name emails phone_numbers Optional benefit_administrator_address
billing_administrator	This element contains contact information for a location-specific Billing Administror. This person may be be used as a contact for billing questions and administration. Required first_name last_name emails phone_numbers Optional benefit_administrator_address

See Additional Documentation for links to our current API documentation.