Write Call
Locations End point
http://DOMAIN/api/API_KEY/location.OUTPUT
Using POST Calls POST requests will ignore parameters supplied as a query string and need any additional parameters in the request Body. To configure the number of Pages/Results returned by the API (this is most useful for the SQL Endpoint), you can send these as additional Parameter's in the Body. Parameter Default Description limit 20 Number of listings to show. page 1 Page number to show. API fields are not case sensitive, and will always be returned in the lower case format.Data Type Interger Interger
UDF parameters are all lower case when processed by PCR-360. Since Organizations can create their own UDF fields, the generic use of IDENTIFIER is used as a placeholder for actual UDF Identifiers.
Location Fields
Name | Type | Available Values | Default Value | Required |
---|---|---|---|---|
location_recid | integer |
| ADD_NEW | UPDATE |
status | boolean | 1, 0 | 1 |
|
parent_location_recid | integer |
| NULL |
|
location_type_recid | integer | LOCATION_TYPE |
| INSERT |
location_type | text | LOCATION_TYPE |
| INSERT |
latitude | float |
| NULL |
|
longitude | float |
| NULL |
|
warehouse | boolean | 1, 0 | 0 |
|
report_911 | boolean | 1, 0 | 0 |
|
default_warehouse_recid | integer |
| NULL |
|
default_return_warehouse_recid | integer |
| NULL |
|
Location Address Fields
Name | Type | Available Values | Default Value | Required |
---|---|---|---|---|
type | text | ADDRESS |
| YES |
building_id | text |
| NULL |
|
community_name | text |
| NULL |
|
street_address | text |
| NULL |
|
address2 | text |
| NULL |
|
city | text |
| NULL |
|
state | text | *Country Dependent | NULL |
|
zip_code | text | *Country Dependent | NULL |
|
country | text | ADDRESS_COUNTIES | NULL |
|
E911 Fields | Type | Default Value |
---|---|---|
house_number | text | NULL |
house_suffix | text | NULL |
prefix_directional | text | NULL |
street_name | text | NULL |
street_suffix | text | NULL |
post_directional | text | NULL |
Address Request Example
Call:
POST DOMAIN/KEY/location.json
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
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 |
---|---|---|---|---|
type | text | CONTACT |
| YES |
location_recid | integer |
|
| INSERT |
contact_recid | integer |
|
| INSERT |
Contacts Request Example
Call:
POST DOMAIN/KEY/location.json
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
type | CONTACT |
location_recid | 1111 |
contact_recid | 1111 |
Location Servicing Equipment Fields
Name | Type | Available Values | Default Value | Required |
---|---|---|---|---|
type | text | SERVICING_EQUIPMENT |
| YES |
location_recid | integer |
|
| INSERT, UPDATE |
service_catalog_recid | integer |
|
| INSERT |
equipment_recid | integer |
|
| INSERT |
Location Servicing Equipment Request Example
Call:
POST DOMAIN/KEY/location.json
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
type | SERVICING_EQUIPMENT |
location_recid | 1111 |
Location Service Host Permission Fields
Name | Type | Available Values | Default Value | Required |
---|---|---|---|---|
type | text | SERVICE_HOST |
| YES |
location_recid | integer |
|
| INSERT |
service_host_recid | integer |
|
| INSERT |
Location Service Hostt Request Example
Call:
POST DOMAIN/KEY/location.json
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
type | SERVICING_HOST |
location_recid | 1111 |
service_host_recid | 2222 |
Location Worker Permission Fields
Name | Type | Available Values | Required |
---|---|---|---|
type | text | WORKER | YES |
location_recid | integer |
| INSERT |
contact_recid | integer |
| INSERT |
Location Servicing Equipment Request Example
Call:
POST DOMAIN/KEY/location.json
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
type | WORKER |
location_recid | 1111 |
contact_recid | 2222 |
Location Remark Fields
Name | Type | Available Values | Required |
---|---|---|---|
type | text | REMARK | YES |
location_recid | integer |
| INSERT |
remark | text |
| INSERT |
author_contact_recid | integer |
| NON-AUTH-KEYS |
Location Servicing Equipment Request Example
Call:
POST DOMAIN/KEY/location.json
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
type | REMARK |
location_recid | 1111 |
remark | “This is a Remark” |
Location UDF Fields
Name | Type | Available Values | Required |
---|---|---|---|
type | text | UDF | YES |
location_recid | integer |
| YES |
udf_UDF-RECID | custom |
|
|
udf_UDF-IDENTIFIER | custom |
|
|
Location Servicing Equipment Request Example
Call:
POST DOMAIN/KEY/location.json
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
type | UDF |
location_recid | 1111 |
udf_RECID | “UDF VALUE” |
Location Attachment Fields
Name | Type | Available Values | Required |
---|---|---|---|
type | text | ATTACHMENT | YES |
location_recid | integer |
| INSERT |
filename | text |
| INSERT |
data | base64 encoded |
| INSERT |
Location Servicing Equipment Request Example
Call:
POST DOMAIN/KEY/location.json
Headers:
Key | Value |
---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|---|
type | SERVICING_EQUIPMENT |
location_recid | 1111 |
filename | “file name” |
data | base64 encoded data |