Location Json Schema

In This Topic

Description

Represents a comprehensive Location record within the OnTime API.

Overview

Location

Represents a comprehensive Location record within the OnTime API.

Zone : Zone

The Zone record assigned to this Location.

ID : string

The unique identifier for this Zone record.

Name : string

The name of this Zone.

PostalCodes : string

The postal codes assigned to this Zone.

Cities : string

A list of comma-separated cities that this zone is associated with.

PolygonPoints : string

A list of comma-separated latitude/longitude coordinates where each pairing is separated by a pipe character '|'. These coordinates represent the geographical boundary of this Zone, and can be drawn on a map.

ID : string

The unique identifier for this Location record.

ContactName : string

The primary contact name associated with this Location.

CompanyName : string

The company name associated with this Location.

AddressLine1 : string

The street address of this Location.

AddressLine2 : string

Additional secondary information related to this Location's street address.

City : string

The city or locality this Location resides within.

State : string

The state, province, or other civil entity this Location resides within.

PostalCode : string

The assigned postal code this Location resides within.

Country : string

The country or other national political entity this Location resides within.

Comments : string

Any additional comments associated with this Location.

Email : string

The email address assigned to this Location.

Phone : string

The phone number assigned to this Location.

Category : string

The category assigned to this Location.

LatitudeLongitude : string

The comma-delimited pair of geographic latitude/longitude coordinates that is assigned to this Location.

AccessCode : string

The access code assigned to this Location.

Properties

Name	Description	Data Type
Zone	The Zone record assigned to this Location.	Zone
ID	The unique identifier for this Location record.	string
ContactName	The primary contact name associated with this Location.	string
CompanyName	The company name associated with this Location.	string
AddressLine1	The street address of this Location.	string
AddressLine2	Additional secondary information related to this Location's street address.	string
City	The city or locality this Location resides within.	string
State	The state, province, or other civil entity this Location resides within.	string
PostalCode	The assigned postal code this Location resides within.	string
Country	The country or other national political entity this Location resides within.	string
Comments	Any additional comments associated with this Location.	string
Email	The email address assigned to this Location.	string
Phone	The phone number assigned to this Location.	string
Category	The category assigned to this Location.	string
LatitudeLongitude	The comma-delimited pair of geographic latitude/longitude coordinates that is assigned to this Location.	string
AccessCode	The access code assigned to this Location.	string