REST Objects Location

5.0.0

The Location object can be part of:

The Appointment Book object, in the following location:
- Appointment Book > Location
In this situation, a Location object represents the location (Address, Contact details and other metadata) to be associated with a Work Item when performing an appointment booking.

or:

The Work Item object, in the following locations:
- Work Item > Location
In this situation, a Location object represents the location (Address, Contact details and other metadata) associated associated with a booked Work Item.

On this page:

Related pages:

Location Object Format

JSON Format

{
	"Address": {
		// Location Object
	},
	"Contacts": [
		{
			// Contacts Object
		},
		{
			// Contacts Object
		},
		...
	],
	"LanguageId": "",
	"LocationNum": "",
	"Name": "",
	"POReq": false,
	"SigReq": false,
	"StorageLocationId": "",
	"Type": "",
	"WorkCenter": ""
}

Location Object Properties

Property	Type	Required?	Description	Field Mappings
Property	Type	Required?	Description	ServiceDispatch	ServiceMobility	ServiceScheduling
`Address`	`object`	No	An Address object, representing the address of the Work Item.
`Contacts`	`array`	No	An array of Contact objects, representing contacts and their contact details for the Work Item.
`LanguageId`	`string`	No	A language code identifier associated with the location.		`/Location/LanguageId`
`LocationNum`	`string`	No	The primary sub-system's unique identifier for the Work Item location.	`ConsumerInfo:SiteID`	`/Location/LocationNum`	`customer.custID`
`Name`	`string`	No	The name of the location.		`/Location/Name`	`customer.custName`
`POReq`	`boolean`	No	When `true`, indicates that a purchase order number is required when visiting the location as part of the associated Work Item.		`/Location/POReq`
`SigReq`	`boolean`	No	When `true`, indicates that a signature must be captured when visiting the location as part of the associated Work Item.		`/Location/SigReq`
`StorageLocationId`	`string`	No	An inventory storage location identifier for the location.		`/Location/StorageLocationId`
`Type`	`string`	No	The type of location (one of `InHome`, `Warehouse` or `Depot`).	`ServiceSite`
`WorkCenter`	`string`	No	The primary sub-system's unique identifier for the Work Center to which the Work Item has been assigned.		`/Location/ServiceAreaID`