Page Comparison

Table of Contents

minLevel	1
maxLevel	6
outline	true
style	none
type	list
printable	true

Write Call

Locations End point

Code Block

language	php

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

Insert excerpt

	SQL API Endpoint
	SQL API Endpoint
nopanel	true

Insert excerpt

	Custom API
	Custom API
nopanel	true

Location Fields

Name

Field	Type

Available Values

Required for Inserts	Required for Updates	Options	Default

Value

Required

location_recid

integer

status

boolean

1, 0

1

Integer

ADD_NEW

UPDATE

Yes
parent_location_recid

integer

Integer

NULL

name

String

Yes

location_type_recid

integer

LOCATION_TYPE
LIST RECID


status	Boolean

INSERT

1, 0	1
location_type	String	Yes

text

Any LOCATION_TYPE List Code

LIST CODE

INSERT

latitude

Decimal

float

NULL


longitude

float

Decimal

NULL


warehouse

boolean

Boolean

1, 0

0

report_911

Boolean

boolean

1, 0

0


default_warehouse_recid	Integer

integer

NULL


default_return_warehouse_recid

integer

Integer

NULL

Location Address Fields

Per the form, these will NOT be required.

...

Name

...

Type

...

Available Values

...

Default Value

...

Required

...

type

*Type is required but all location field may also be provided.

...

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

text

String

NULL


community_name

text

NULL

String

street_address

text

String

NULL


address2

text

String

NULL


city

text

String

NULL


state

text

*Country Dependent
State abbreviation or name

NULL

String			Full name or abbreviation
zip_code

text

String

*Country Dependent

NULL


country	String

text

Any ADDRESS_COUNTIES

LIST CODE

NULL

List Code

E911 Fields	Type

Default Value
house_number

text

String

NULL

house_suffix

text

String

NULL

prefix_directional

text

String

NULL

street_name

text

String

NULL

street_suffix

text

NULL

post_directional

text

NULL

String	NULL
post_directional	String	NULL

Address Request Example

Call:

Code Block

language	php

POST DOMAIN/KEY/locations.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

Required

Name	Type

Available Values

Default Value

Required for Inserts	Required for Updates	Options
type	text

CONTACT

Yes

N/A

YES

CONTACT

location_recid

integer

Integer

Yes

INSERT

contact_recid

integer

Integer

Yes

INSERT

Contacts Request Example

Call:

Code Block

language	php

POST DOMAIN/KEY/locations.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

Field	Type

Available Values

Default Value

Required

type

text

Required for Inserts	Required for Updates	Options
type	String	Yes	N/A	SERVICING_EQUIPMENT

YES

location_recid

integer

Integer

Yes

INSERT, UPDATE

service_catalog_recid

Integer

integer

Yes

INSERT

equipment_recid

integer

Integer

Yes

INSERT

Location Servicing Equipment Request Example

Call:

Code Block

language	php

POST DOMAIN/KEY/locations.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

Required for Inserts	Required for Updates	Options
type	String	Yes	N/A	SERVICE_HOST

YES

location_recid

integer

Integer

Yes

INSERT

service_host_recid

integer

Integer

Yes

INSERT

Location Service Hostt Request Example

Call:

Code Block

language	php

POST DOMAIN/KEY/locations.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

Required

Name	Type

Available Values

Default Value

Required for Inserts	Required for Updates	Options
type

text

String

WORKER

Yes

N/A

YES

WORKER

location_recid

integer

Integer

Yes

INSERT

contact_recid

integer

Integer

Yes

INSERT

Location Servicing Equipment Request Example

Call:

Code Block

language	php

POST DOMAIN/KEY/locations.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

Required

Name	Type

Available Values

Default Value

Required for Inserts	Required for Updates	Options
type

text

String

REMARK

Yes

N/A

YES

REMARK

location_recid

integer

Integer

Yes

INSERT

remark

String

text

Yes

INSERT

author_contact_recid

integer

Integer

NON-AUTH-KEYS

Location Servicing Equipment Request Example

Call:

Code Block

language	php

POST DOMAIN/KEY/locations.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

Required

Name	Type

Available Values

Default Value

Required for Inserts	Required for Updates	Options
type

text

String

UDF

Yes

N/A

YES

UDF
location_recid	Integer

integer

Yes

YES

udf_UDF-RECID

custom

String	Conditionally required if “udf_UDF-IDENTIFIER” not provided
udf_UDF-IDENTIFIER

custom

String

Conditionally required if “udf_UDF-RECID” not provided

Location Servicing Equipment Request Example

Call:

Code Block

language	php

POST DOMAIN/KEY/locations.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

Required

Name	Type

Available Values

Default Value

Required for Inserts	Required for Updates	Options
type

text

String

ATTACHMENT

Yes

N/A

YES

ATTACHMENT

location_recid

integer

Integer

Yes

INSERT

filename

String

text

Yes

INSERT

data

String

base64 encodedINSERT

Yes

Base64 Encoded Text

Location Servicing Equipment Request Example

Call:

Code Block

language	php

POST DOMAIN/KEY/locations.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

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Write Call

Location Fields

Location Address Fields

Address Request Example

Call:

Headers:

Body:

Location Contact Fields

Contacts Request Example

Call:

Headers:

Body:

Location Servicing Equipment Fields

Location Servicing Equipment Request Example

Call:

Headers:

Body:

Location Service Host Permission Fields

Location Service Hostt Request Example

Call:

Headers:

Body:

Location Worker Permission Fields

Location Servicing Equipment Request Example

Call:

Headers:

Body:

Location Remark Fields

Location Servicing Equipment Request Example

Call:

Headers:

Body:

Location UDF Fields

Location Servicing Equipment Request Example

Call:

Headers:

Body:

Location Attachment Fields

Location Servicing Equipment Request Example

Call:

Headers:

Body: