Document toolboxDocument toolbox

Service Area Query Object

Owned by Andrew Hill (Deactivated)
Last updated: Oct 03, 2024 by Jason Andrew
1 min read

The Service Area Query object contains specific details related to a service area. A service area may have zero or more service teams assigned to it. Service Area Query object also contains information about associated price list.


On this page:


Service Area Object Formats

JSON Format 
 {
	"Name": "",
	"PriceListID": "",
	"PriceListName": "",
	"ServiceAreaID": "",
	"ServiceTeams": [{
		"ServiceTeamID": "",
		"Name": ""
	}],
	"TimeZone": ""
}

Service Area Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
NamestringIdentifies the name of the service area
PriceListIDstringIdentifies the price list associated with the service area
PriceListNamestringIdentifies the price list name associated with the service area
ServiceAreaIDstringIdentifies the unique ID of the service area
ServiceTeamscollection

This collection contains zero or more service teams assigned to a service area.

PropertyTypeDescription
ServiceTeamIDstringIdentifies the unique ID of the service team
NamestringIdentifies the name of the service team
TimeZonestringIdentifies the time zone that the service area is located in.