...
| Code Block | ||
|---|---|---|
| ||
http://DOMAIN/api/API_KEY/locationlocations.OUTPUT |
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Location Fields
Field | Type |
|---|
Available Values
Default Value
Required for Inserts | Required for Updates | Options | Default | |
|---|---|---|---|---|
location_recid |
status
boolean
1, 0
1
Integer |
|
ADD_NEW
UPDATE
Yes |
|
|
parent_location_recid |
Integer |
|
|
|
|
name | String | Yes |
|
|
location_type_recid
integer
LIST RECID
| |||
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
...
Name
...
Type
...
Available Values
...
Default Value
...
Required
...
type
...
text
...
ADDRESS
...
...
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 |
|---|---|---|---|---|
type | String | Yes | N/A | ADDRESS |
building_id |
String |
|
|
|
community_name |
String |
|
|
|
street_address |
String |
|
|
|
address2 |
String |
|
|
|
city |
String |
|
|
|
state | String |
|
*Country Dependent
State abbreviation or name
NULL
| Full name or abbreviation |
zip_code |
String |
|
|
| |
country | String |
|
| Any ADDRESS_COUNTIES |
NULL
List Code |
E911 Fields | Type | Default Value |
|---|---|---|
house_number | textString | NULL |
house_suffix | textString | NULL |
prefix_directional | textString | NULL |
street_name | textString | NULL |
street_suffix | textString | NULL |
post_directional | textString | NULL |
Address Request Example
...
| Code Block | ||
|---|---|---|
| ||
POST DOMAIN/KEY/locationlocations.json |
Headers:
Key | Value |
|---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
...
Key | Value |
|---|---|
type | ADDRESS |
street_address | “555 Nowhere Ave” |
city | “Grand Rapids” |
state | “MI” |
zip_code | “55555” |
Location Contact Fields
Name | Type |
|---|
Available Values
Default Value
Required for Inserts | Required for Updates | Options |
|---|---|---|
type | text |
Yes |
N/A |
CONTACT |
location_recid |
Integer | Yes |
|
|
INSERT
contact_recid |
Integer | Yes |
|
|
Contacts Request Example
Call:
| Code Block | ||
|---|---|---|
| ||
POST DOMAIN/KEY/locationlocations.json |
Headers:
Key | Value |
|---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
...
Location Servicing Equipment Fields
Field | Type |
|---|
Available Values
Default Value
Required
type
Required for Inserts | Required for Updates | Options | ||
|---|---|---|---|---|
type | String | Yes | N/A | SERVICING_EQUIPMENT |
YES
location_recid |
Integer | Yes |
|
|
service_catalog_recid |
Integer | Yes |
|
|
equipment_recid |
Integer | Yes |
|
|
INSERT
Location Servicing Equipment Request Example
...
| Code Block | ||
|---|---|---|
| ||
POST DOMAIN/KEY/locationlocations.json |
Headers:
Key | Value |
|---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
...
Location Service Host Permission Fields
Name | Type |
|---|
Available Values
Default Value
Required for Inserts | Required for Updates | Options |
|---|---|---|
type |
String | Yes | N/A | SERVICE_HOST |
YES
location_recid |
Integer | Yes |
|
|
service_host_recid |
Integer | Yes |
|
|
INSERT
Location Service Hostt Request Example
...
| Code Block | ||
|---|---|---|
| ||
POST DOMAIN/KEY/locationlocations.json |
Headers:
Key | Value |
|---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
...
Location Worker Permission Fields
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
...
| Code Block | ||
|---|---|---|
| ||
POST DOMAIN/KEY/locationlocations.json |
Headers:
Key | Value |
|---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
...
Key | Value |
|---|---|
type | WORKER |
location_recid | 1111 |
contact_recid | 2222 |
Location Remark Fields
Name | Type |
|---|
Required for Inserts | Required for Updates | Options |
|---|---|---|
type |
String | Yes | N/A | REMARK |
YES
location_recid | Integer |
Yes |
|
|
remark |
String | Yes |
|
|
author_contact_recid |
Integer |
|
|
|
Location Servicing Equipment Request Example
...
| Code Block | ||
|---|---|---|
| ||
POST DOMAIN/KEY/locationlocations.json |
Headers:
Key | Value |
|---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
...
Key | Value |
|---|---|
type | REMARK |
location_recid | 1111 |
remark | “This is a Remark” |
Location UDF Fields
Name | Type |
|---|
Required for Inserts | Required for Updates | Options |
|---|---|---|
type |
String | Yes | N/A | UDF |
YES
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
...
| Code Block | ||
|---|---|---|
| ||
POST DOMAIN/KEY/locationlocations.json |
Headers:
Key | Value |
|---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
...
Location Attachment Fields
Name | Type |
|---|
Required for Inserts | Required for Updates | Options |
|---|---|---|
type |
String | Yes | N/A | ATTACHMENT |
YES
location_recid |
Integer | Yes |
|
|
filename |
String | Yes |
|
| |
data | String |
Yes |
|
Base64 Encoded Text |
Location Servicing Equipment Request Example
...
| Code Block | ||
|---|---|---|
| ||
POST DOMAIN/KEY/locationlocations.json |
Headers:
Key | Value |
|---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
...