Products Guardian APIs REST APIs Standard Endpoints Company Methods POST/ locations

POST/ locations

This API is used to create a new location within Guardian. Locations often represent a physical worksite or job location. Every employee must be assigned to a location. Location assignment assists with reporting as well as manages employee E-Verify eligibility. Reference the locations data model for detailed parameter information.

Method

POST

Resource Information

Requires authentication?	YES
Request formats	JSON
Response formats	JSON

Parameters

Parameter	Label	Description	Type	Max Length	Required
id		Guardian system generated unique key	int	N/A
name	Name	Location’s name	string	80	No
number	Location No.	Location’s number	string	15	No
everifyLocation	E-Verify	Location’s E-Verify status; When false, E-Verify is enabled for the location	invert_bool	N/A	No
legalEntity		Legal Entity (EIN) to which the location reports	int	N/A	No
overrideMinEmploymentAge		Utilize the override function if this location’s minimum age requirement differs from the default minimum age requirement set at the organization level	bool	N/A	No
minEmploymentAge	Location Employee Min Age	Defines location’s minimum age requirement	int	N/A	No
overrideWorkdays		Utilize the override function if this location’s days of operation differ from the default work days set at the organization level.	bool	N/A	No
workMonday	Monday	Defines if location is open Mondays	bool	N/A	No
workTuesday	Tuesday	Defines if location is open Tuesdays	bool	N/A	No
workWednesday	Wednesday	Defines if location is open Wednesdays	bool	N/A	No
workThursday	Thursday	Defines if location is open Thursdays	bool	N/A	No
workFriday	Friday	Defines if location is open Fridays	bool	N/A	No
workSaturday	Saturday	Defines if location is open Saturdays	bool	N/A	No
workSunday	Sunday	Defines if location is open Sundays	bool	N/A	No
workHolidays	Federal Holidays	Defines if location is open federal holidays	bool	N/A	No
addressStreet	Line 1	Physical street address	string	80	No
addressStreet2	Line 2	Physical street address	string	80	No
addressCity	City	City address	string	50	No
addressState	State	State address	string	20	No
addressCountry	Country	Country address	string	50	No
addressZip	Zip	Zip code address	string	10	No
phoneNumber	Phone	Main phone number	string	N/A	No
faxNumber	Fax	Fax number	string	N/A	No

Example

Request Example

POST https://<server>/v1/locations

{
    "name": "4917-06211-Fresno-5501 Golden State Blvd",
    "workWednesday": "",
    "legalEntity": "",
    "number": "",
    "faxNumber": "",
    "minEmploymentAge": "",
    "workMonday": "",
    "overrideMinEmploymentAge": "",
    "workFriday": "",
    "addressCountry": "",
    "addressStreet": "3112 N. Central Ave",
    "workTuesday": "",
    "phoneNumber": "",
    "workHolidays": "",
    "workThursday": "",
    "addressCity": "Phoenix",
    "workSunday": "",
    "workSaturday": "",
    "addressState": "",
    "addressStreet2": "Suite A-200 ",
    "everifyLocation": true,
    "overrideWorkdays": "",
    "addressZip": "85012"
}

Response Example

{
    "id": 10714,
    "name": "4917-06211-Fresno-5501 Golden State Blvd",
    "workWednesday": "",
    "legalEntity": "",
    "number": "",
    "faxNumber": "",
    "minEmploymentAge": "",
    "workMonday": "",
    "overrideMinEmploymentAge": "",
    "workFriday": "",
    "addressCountry": "",
    "addressStreet": "3112 N. Central Ave",
    "workTuesday": "",
    "phoneNumber": "",
    "workHolidays": "",
    "workThursday": "",
    "addressCity": "Phoenix",
    "workSunday": "",
    "workSaturday": "",
    "addressState": "",
    "addressStreet2": "Suite A-200 ",
    "everifyLocation": true,
    "overrideWorkdays": "",
    "addressZip": "85012",
    "links": [
        {
            "href": "/v1/locations/18714/",
            "rel": "self"
        }
    ]
}