Versions Compared

Version Old Version 6 New Version Current
Changes made by

Andrew Hill

Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space SBUD and version 5

Status
colourGreen
title5.0.0

Info

The Booking object can be part of:

  • The Appointment Book object, in the following location:
  • 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:
  • 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.
Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

Related pages:

Booking Object FormatFormat  

Include Page
_Booking Object Format
_Booking Object Format

Booking Object Properties


No
PropertyTypeRequired?DescriptionField Mappings
ServiceDispatchServiceMobilityServiceScheduling
OfferobjectNo

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.

Booking.Offer.Offerng

N/AN/A
OrderDateUTC Date/TimeNo

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.

Booking.Offer.OfferId

/OrderDatedate
SchdArrUTC Date/TimeNo

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.

ServiceCenterBooking.Offer.SchdStart 

N/A(expectedStart + travel)
SchdStartUTC Date/TimeNo

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)/PlannedStartDateexpectedStart
SchdEndUTC Date/TimeNo

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)/PlannedEndDateexpectedEnd
ServiceDescstringNo

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 NameN/AfruDescription
ServiceOrgstringNo

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.

ServiceCenterN/AFRU
TechstringNo

The ID of the assigned worker.

Not required to be set when booking a Work Item; present when viewing a booked Work Item.

N/A/UserNamescheduledEmpOfferobject

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.

TechInfoobjectNo

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.

N/AN/AN/A
ServiceOrgInfoobjectNo

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.

N/AN/AN/A