REST Objects Booking

5.0.0

The Booking object can be part of:

The Appointment Book object, in the following location:
- Appointment Book > Booking
In this situation, a Booking object represents the details of when a Work Item is desired to be "booked" (i.e. scheduled), including additional details such as who should perform the work, when performing an appointment booking.

or:

The Work Item object, in the following locations:
- Work Item > Booking
In this situation, a Booking object represents the details of a Work Item has been "booked" (i.e. scheduled), including additional details such as who will perform the work.

On this page:

Related pages:

Booking Object Format

JSON Format

{
    "OrderDate": "",
    "SchdArr": "",
    "SchdStart": "",
    "SchdEnd": "",
    "ServiceDesc": "",
    "ServiceOrg": "",
    "Tech": "",
    "Offer": {
		// Offer Object
    },
    "TechInfo": {
		"Name": "",
        "Phone": "",
        "ImageUrl": ""
    },
 	"ServiceOrgInfo": {
		"Name": "",
		"ServiceOrg": "",
		"ExtSysId": "",
		"Address": {
			"AddrLine1": "",
			"AddrLine2": "",
			"City": "",
			"Region": "",
			"PostalCode": "",
			"Country": ""
		},
		"Phone": "",
    	"Email": "",
	    "ImageUrl": ""
	}
}

Booking Object Properties

Property	Type	Required?	Description	Field Mappings
Property	Type	Required?	Description	ServiceDispatch	ServiceMobility	ServiceScheduling
`OrderDate`	`UTC Date/Time`	No	The UTC date and time when the Work Item was created, in ISO-8601 format using pattern `YYYY-MM-DDTHH:mm:SS.sssZ`. Not required to be set when booking a Work Item; present when viewing a booked Work Item.		`/OrderDate`	`date`
`SchdArr`	`UTC Date/Time`	No	The UTC date and time the Worker allocated to the Work Item is scheduled to arrive on site, in ISO-8601 format using pattern `YYYY-MM-DDTHH:mm:SS.sssZ`. Not required to be set when booking a Work Item; present when viewing a booked Work Item.			`(expectedStart + travel)`
`SchdStart`	`UTC Date/Time`	No	The UTC date and time the Worker allocated to the Work Item is scheduled to start travelling to the site, in ISO-8601 format using pattern `YYYY-MM-DDTHH:mm:SS.sssZ`. Not required to be set when booking a Work Item; present when viewing a booked Work Item.	`(OfferIDCollection:SchdDelDate + OfferIDCollection:TimePeriod)`	`/PlannedStartDate`	`expectedStart`
`SchdEnd`	`UTC Date/Time`	No	The UTC date and time the Worker allocated to the Work Item is scheduled to complete the work, in ISO-8601 format using pattern `YYYY-MM-DDTHH:mm:SS.sssZ`. Not required to be set when booking a Work Item; present when viewing a booked Work Item.	`(OfferIDCollection:SchdDelDate + OfferIDCollection:TimePeriod)`	`/PlannedEndDate`	`expectedEnd`
`ServiceDesc`	`string`	No	A description of the organization or group responsible for servicing the job. Not required to be set when booking a Work Item; present when viewing a booked Work Item.	`Servicer Name`		`fruDescription`
`ServiceOrg`	`string`	No	The organization or group responsible for servicing the job. Not required to be set when booking a Work Item; present when viewing a booked Work Item.	`ServiceCenter`		`FRU`
`Tech`	`string`	No	The ID of the assigned worker. Not required to be set when booking a Work Item; present when viewing a booked Work Item.		`/UserName`	`scheduledEmp`
`Offer`	`object`	No	In the context of a requesting an appointment offer for a new Work Item, an REST Objects Appointment Offer containing details of the appointment offer. Required when booking a Work Item; not present when viewing a booked Work Item.
`TechInfo`	`object`	No	Where the Primary Sub-System is ServiceDispatch, the ServiceDispatch `TechInfo` object. Not required to be set when booking a Work Item; present when viewing a booked Work Item.
`ServiceOrgInfo`	`object`	No	Where the Primary Sub-System is ServiceDispatch, the ServiceDispatch `ServicerInfo` object. Not required to be set when booking a Work Item; present when viewing a booked Work Item.