Appointment Book Object Format
| Include Page | ||||
|---|---|---|---|---|
|
Appointment Book Object Properties
Field Mappings
REST Work Item Appointment Book calls may result in an appointment booking request being directed to either a ServiceDispatch system, a ServiceScheduling system, or both. (See the REST Work Item Appointment Search definition for details on how this is configured).
As a result, all of the fields in the Appointment Book Object are passed through to ServiceDispatch and/or ServiceScheduling, which means that the field definitions depend on the API that they are passed to.
In addition, fields may, or may not be, mandatory, depending on the system(s) to which they are passed, with the exception of some fields which are mandated by ServiceBroker itself (and which are marked below).
ServiceDispatch Field Mappings
When an REST Work Item Appointment Book call results in an appointment booking request being directed to ServiceDispatch, the fields that are present in the Appointment Book Object (below) with a ServiceDispatch field mapping will be passed to ServiceDispatch.
As a result, the definition of these fields depends on how ServiceDispatch handles the fields.
Please speak with the ServicePower customer services team for the field definitions.
ServiceScheduling Field Mappings
When an REST Work Item Appointment Book call results in an appointment booking request being directed to ServiceScheduling, the fields that are present in the Appointment Book Object (below) with a ServiceScheduling field mapping will be passed to ServiceScheduling.
As a result, the definition of these fields depends on how ServiceScheduling handles the fields.
Please see the appropriate version of the ServiceScheduling sp:ApptBookRequest API for the field definitions.
| Property | Type | Required? | Description | Field Mappings | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceDispatch | ServiceScheduling | |||||||
Assets | array | No | An array of Asset objects, representing properties related to items of physical equipment (i.e. assets) that need to be associated with the Work Item that will be created as result of the appointment booking request (e.g. normally, assets located at the location of the Work Item). | See: Asset objects | See:Asset objects | |||
Booking | object | No | A Booking object, representing details of when the Work Item is to be carried out, who will be performing the work, etc. Details of the REST Objects Appointment Offer obtained via the REST Work Item Appointment Search are included in the Booking object, as part of the process of allowing a Work Item to be created based on an appointment offer. | See: Booking objects | See Booking Objects Objects | |||
Desc | string | No | A short description of the Work Item that will be created as result of the appointment booking request. | desc | desc | |||
Desc2 | string | No | An additional field for further text describing the Work Item that will be created as result of the appointment booking request. | desc2 | desc2 | |||
Flags | object | No | A Flags object, representing various boolean flag values to be set for the Work Item that will be created as result of the appointment booking request. | See: Flags objects | See: Flags objects | |||
FlexView | array | No | An array of FlexView objects, representing associated flexible "extra" items of information to be associated with the Work Item that will be created as result of the appointment booking request. | See FlexView objects | See:FlexView objects | |||
Id | string | Yes | A unique identifier for the Work Item that will be created as result of the appointment booking request. | mfgId:CallNo -> OrderNum | JobId | |||
Location | object | No | A Location object, representing the location to be associated with the Work Item that will be created as result of the appointment booking request. | N/A | N/A | |||
Notes | string | No | Any notes to be associated with the Work Item that will be created as result of the appointment booking request. | N/A |
| |||
Payment | array | No | An array of Payment objects, representing payment information to be associated with the Work Item that will be created as result of the appointment booking request. | See: Payment objects | See: Payment objects | |||
Priority | string | No | A representation of the priority (importance) of the Work Item that will be created as result of the appointment booking request.
| N/A | priority(0-99) | |||
TimeConstraints | array | No | An array of TimeConstraint objects, representing any constraints relating to when the Work Item that will be created as a result of the appointment booking request can be performed. | See: TimeConstraint objects | See: TimeConstraint objects | |||
Type | string | No | The type of work (i.e. Job, Break or Activity) for the Work Item that will be created as result of the appointment booking request. | N/A | N/A | |||
WorkStatus | integer | No | A code representing the status of the Work Item that will be created as result of the appointment booking request.
| CallStatus | disStatus | |||
WorkType | object | No | A WorkType object, representing the type of work that the Work Item that will be created as a result of the appointment booking request relates to in, more detail than the Type field. | See: WorkType object | See: WorkType object | |||
The ServiceBroker Appointment Book Object