BookLocID | string
| SS: 4 | Unique identifier of the location (or service) from which the job is booked. If at a later time, for example when a job becomes earmarked, ServiceOptimizer needs to send out a message, this location is used to look up (in the ServiceOptimizer database) the address of the service it is sent to. | No | bookLoc |
ContractEarliest | string
| SS: 16 | The earliest time that the job should be started (ETA). If ContractEarliest is not supplied, then ContractEarliest will be defaulted to <now>. Example: "2023-03-30T14:15" | No | contractEarliest |
ContractLatest | string
| SS: 16 | The time by which the job should either be started (ETA) or completed, depending on the value of callToFix. Example: "2023-03-30T14:15" | Yes | contractLatest |
Offer | object |
| Property | Type | Length | Description | Field mapping: ServiceScheduling |
---|
GroupID | string
| SS: 30 | Jobs with the same groupID should be allocated in the minimum number of contiguous groups that are needed to meet their Access Hours constraints. Like a siteID, a groupID is treated as an opaque value by ServiceOptimizer. Where this booking is based on offers from a previous call to OfferAppts, the values supplied in this field in this booking request must be the same as those supplied on the OfferAppts call. | groupID |
| Yes | - |
OpenAccHoursOvrs | object |
| A set of open Access Hours overrides for this job. If overlapping open Access Hours override periods are supplied, the overlaps are silently removed – two overlapping open Access Hours overrides will be merged into one, for example. Similarly, overlapping closed Access Hours overrides periods are also merged. Property | Type | Length | Description | Req? | Field mapping: ServiceScheduling |
---|
OpenType | string
| SS: See Valid Values | If OpenType is Add, then the open overrides are added to the existing Access Hours for the job. If OpenType is Replace, the supplied replace open overrides work in a per-calendar-day manner, i.e. the overrides replace the existing Access Hours time periods that start on the same day that the supplied open overrides start on. So, for example, if a job has two existing Access Hours periods starting on a particular day, and there’s only one replace open override starting on that day, then the end result is to only have one Access Hours time period starting on that day SS Valid Values: "Add", "Replace" | Yes | openAccHoursOvrs.openType | OpenHours | array of objects |
| Property | Type | Length | Description | Req? | Field mapping: ServiceScheduling |
---|
Start | string
| SS: 16 | Example: "2023-03-30T14:15" SS Field: | Yes | openAccHoursOvrs.openHours[].start | End | string | SS: 16 | Example: "2023-03-30T14:15"
| Yes | openAccHoursOvrs.openHours[].end |
| Yes | - |
| No |
|
ClosedAccHoursOvrs | object |
| A set of closed Access Hours overrides for this job. Closed overrides are converted into open overrides before being stored. Property | Type | Description | Req? | Field mapping: ServiceScheduling |
---|
ClosedHours | object | Property | Type | Length | Description | Req? | Field mapping: ServiceScheduling |
---|
Start | string
| SS: 16 | Example: "2023-03-30T14:15"
| Yes | closedAccHoursOvrs.closedHours[].start | End | string
| SS: 16 | Example: "2023-03-30T14:15" | Yes | closedAccHoursOvrs.closedHours[].end |
| Yes | - |
| No |
|
ClosedPubHols | object |
| Property | Type | Length | Description | Req? | Field mapping: ServiceScheduling |
---|
PubHolSets | array of strings
| SS: 30 | pending | Yes | closedPubHols |
| No |
|
ClosedDates | array of objects |
| A set of closed dates (i.e. closed whole days) for this job. ClosedDates applies only to Service Hours, not to Access Hours. Property | Type | Length | Description | Req? | Field mapping: ServiceScheduling |
---|
Start | string | SS: 8 | Example: "2023-03-30" | Yes | closedDates.dateRange[].start | End | string | SS: 8 | Example: "2023-03-30" | Yes | closedDates.dateRange[].end |
|