(2024.2) Locations API Endpoint

1 Write Call
2 Location Fields
3 Location Address Fields
- 3.1 Address Request Example
  - 3.1.1 Call:
  - 3.1.2 Headers:
  - 3.1.3 Body:
4 Location Contact Fields
- 4.1 Contacts Request Example
  - 4.1.1 Call:
  - 4.1.2 Headers:
  - 4.1.3 Body:
5 Location Servicing Equipment Fields
- 5.1 Location Servicing Equipment Request Example
  - 5.1.1 Call:
  - 5.1.2 Headers:
  - 5.1.3 Body:
6 Location Service Host Permission Fields
- 6.1 Location Service Hostt Request Example
  - 6.1.1 Call:
  - 6.1.2 Headers:
  - 6.1.3 Body:
7 Location Worker Permission Fields
- 7.1 Location Servicing Equipment Request Example
  - 7.1.1 Call:
  - 7.1.2 Headers:
  - 7.1.3 Body:
8 Location Remark Fields
- 8.1 Location Servicing Equipment Request Example
  - 8.1.1 Call:
  - 8.1.2 Headers:
  - 8.1.3 Body:
9 Location UDF Fields
- 9.1 Location Servicing Equipment Request Example
  - 9.1.1 Call:
  - 9.1.2 Headers:
  - 9.1.3 Body:
10 Location Attachment Fields
- 10.1 Location Servicing Equipment Request Example
  - 10.1.1 Call:
  - 10.1.2 Headers:
  - 10.1.3 Body:

Write Call

Locations End point

http://DOMAIN/api/API_KEY/locations.OUTPUT

Location Fields

Field	Type	Required for Inserts	Required for Updates	Options	Default

Field	Type	Required for Inserts	Required for Updates	Options	Default
location_recid	Integer		Yes
parent_location_recid	Integer
name	String	Yes
status	Boolean			1, 0	1
location_type	String	Yes		Any LOCATION_TYPE List Code
latitude	Decimal
longitude	Decimal
warehouse	Boolean			1, 0	0
report_911	Boolean			1, 0	0
default_warehouse_recid	Integer
default_return_warehouse_recid	Integer

Location Address Fields

The ADDRESS fields are unique in that all Locations can be used along with Address Fields. This can be useful when a User desires to make an API Call to Update a Location and its Address. Rather than making two separate calls, they can make one call for the other location and apply the Address details.

Field	Type	Required for Inserts	Required for Updates	Options

Field	Type	Required for Inserts	Required for Updates	Options
type	String	Yes	N/A	ADDRESS
building_id	String
community_name	String
street_address	String
address2	String
city	String
state	String			Full name or abbreviation
zip_code	String
country	String			Any ADDRESS_COUNTIES List Code

E911 Fields	Type	Default Value

E911 Fields	Type	Default Value
house_number	String	NULL
house_suffix	String	NULL
prefix_directional	String	NULL
street_name	String	NULL
street_suffix	String	NULL
post_directional	String	NULL

Address Request Example

Call:

POST DOMAIN/KEY/locations.json

Headers:

Key	Value

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value

Key	Value
type	ADDRESS
street_address	“555 Nowhere Ave”
city	“Grand Rapids”
state	“MI”
zip_code	“55555”

Location Contact Fields

Name	Type	Required for Inserts	Required for Updates	Options

Name	Type	Required for Inserts	Required for Updates	Options
type	text	Yes	N/A	CONTACT
location_recid	Integer	Yes
contact_recid	Integer	Yes

Contacts Request Example

Call:

POST DOMAIN/KEY/locations.json

Headers:

Key	Value

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value

Key	Value
type	CONTACT
location_recid	1111
contact_recid	1111

Location Servicing Equipment Fields

Field	Type	Required for Inserts	Required for Updates	Options

Field	Type	Required for Inserts	Required for Updates	Options
type	String	Yes	N/A	SERVICING_EQUIPMENT
location_recid	Integer	Yes
service_catalog_recid	Integer	Yes
equipment_recid	Integer	Yes

Location Servicing Equipment Request Example

Call:

Headers:

Key	Value

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value

Key	Value
type	SERVICING_EQUIPMENT
location_recid	1111

Location Service Host Permission Fields

Name	Type	Required for Inserts	Required for Updates	Options

Name	Type	Required for Inserts	Required for Updates	Options
type	String	Yes	N/A	SERVICE_HOST
location_recid	Integer	Yes
service_host_recid	Integer	Yes

Location Service Hostt Request Example

Call:

Headers:

Key	Value

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value

Key	Value
type	SERVICING_HOST
location_recid	1111
service_host_recid	2222

Location Worker Permission Fields

Name	Type	Required for Inserts	Required for Updates	Options

Name	Type	Required for Inserts	Required for Updates	Options
type	String	Yes	N/A	WORKER
location_recid	Integer	Yes
contact_recid	Integer	Yes

Location Servicing Equipment Request Example

Call:

Headers:

Key	Value

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value

Key	Value
type	WORKER
location_recid	1111
contact_recid	2222

Location Remark Fields

Name	Type	Required for Inserts	Required for Updates	Options

Name	Type	Required for Inserts	Required for Updates	Options
type	String	Yes	N/A	REMARK
location_recid	Integer	Yes
remark	String	Yes
author_contact_recid	Integer

Location Servicing Equipment Request Example

Call:

Headers:

Key	Value

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value

Key	Value
type	REMARK
location_recid	1111
remark	“This is a Remark”

Location UDF Fields

Name	Type	Required for Inserts	Required for Updates	Options

Name	Type	Required for Inserts	Required for Updates	Options
type	String	Yes	N/A	UDF
location_recid	Integer	Yes
udf_UDF-RECID	String	Conditionally required if “udf_UDF-IDENTIFIER” not provided
udf_UDF-IDENTIFIER	String	Conditionally required if “udf_UDF-RECID” not provided

Location Servicing Equipment Request Example

Call:

Headers:

Key	Value

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value

Key	Value
type	UDF
location_recid	1111
udf_RECID	“UDF VALUE”

Location Attachment Fields

Name	Type	Required for Inserts	Required for Updates	Options

Name	Type	Required for Inserts	Required for Updates	Options
type	String	Yes	N/A	ATTACHMENT
location_recid	Integer	Yes
filename	String	Yes
data	String	Yes		Base64 Encoded Text

Location Servicing Equipment Request Example

Call:

Headers:

Key	Value

Key	Value
Content-Type	application/json
Pcr-Html-Encoded	TRUE

Body:

Key	Value

Key	Value
type	SERVICING_EQUIPMENT
location_recid	1111
filename	“file name”
data	base64 encoded data