> For the complete documentation index, see [llms.txt](https://ideonapi.gitbook.io/enrollment/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ideonapi.gitbook.io/enrollment/implementation-resources/mapping-guides/locations.md).

# 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_location`on the group, or one of many secondary `locations`created 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.&#x20;

If your system stores this information, it will be useful to implement to `locations`and 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`.&#x20;
* 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

<table><thead><tr><th width="259">Ideon </th><th>Usage and Mapping</th></tr></thead><tbody><tr><td>external_identifier</td><td>This is an identifier that your system can use or generate to identify the <code>location</code>. This is in addition to our <code>id</code> that we generate upon creation. </td></tr><tr><td>type</td><td><p>This is the specific type of  <code>location</code> - physical or remote.</p><p></p><p><strong>When this value is <code>remote</code>, an address object is not required.</strong></p><p></p><p>Enumeration: </p><ul><li>physical</li><li>remote </li></ul></td></tr><tr><td>employer_address</td><td><p>This address element is required for all <code>physical</code> locations. The value follows the same address schema as our other <code>address</code>objects: </p><p></p><p><mark style="background-color:red;">Required</mark><br>address_line_1 <br>city<br>zip <br><br><mark style="background-color:purple;">Recommended</mark> if present<br>address_line_2 <br>state <br>fips_county_code <br>country_code<br> </p><p>Note: Ideon currently only supports domestic addresses for enrollments, the country code can be defaulted to USA (as it will be if not provided)</p></td></tr></tbody></table>

### Optional Elements&#x20;

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.&#x20;

These elements are <mark style="background-color:green;">Optional</mark>

<table><thead><tr><th width="190.319580078125">Ideon</th><th>Usage and Mapping</th></tr></thead><tbody><tr><td>mailing_address</td><td><p>This is the mailing address for a given location, which can differ from the address provided on the <code>employer_address</code> object. </p><p></p><p>The value follows the same address schema as our other <code>address</code>objects: </p><p></p><p><mark style="background-color:red;">Required</mark><br>address_line_1 <br>city<br>zip <br><br><mark style="background-color:purple;">Recommended</mark> if present<br>address_line_2 <br>state <br>fips_county_code <br>country_code<br> </p><p>Note: Ideon currently only supports domestic addresses for enrollments, the country code can be defaulted to USA (as it will be if not provided)</p></td></tr><tr><td>benefit_administrator</td><td><p>This element contains contact information for a location-specific Benefit Administror.</p><p><br>This person may be used as a contact for benefit administration.</p><p></p><p><mark style="background-color:red;">Required</mark><br>first_name <br>last_name<br>emails</p><p>phone_numbers<br><br><mark style="background-color:purple;">Optional</mark> <br>benefit_administrator_address <br></p></td></tr><tr><td>billing_administrator</td><td><p>This element contains contact information for a location-specific Billing Administror.</p><p><br>This person may be be used as a contact for billing questions and administration. </p><p></p><p><mark style="background-color:red;">Required</mark><br>first_name <br>last_name<br>emails</p><p>phone_numbers<br><br><mark style="background-color:purple;">Optional</mark> <br>benefit_administrator_address </p></td></tr></tbody></table>

See Additional Documentation for links to our current API documentation.
