Versions Compared

Version Old Version 7 New Version 8
Changes made by

Andrew Hill

Mickey Bushman

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

The Appointment Offer object represents the appointment offerings (if any) returned from a REST Work Item Appointment Search.

Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

Related pages:

Appointment Offer Object Format

Include Page
_Appointment Offer Object Format
_Appointment Offer Object Format

Appointment Offer Object Properties

Field Mappings

Appointment Search API calls may result in an appointment search being directed to either a ServiceDispatch system, a ServiceScheduling system, or both. (See the Appointment Search API definition for details on how this is configured).

As a result, some of the appointment offer response field definitions depend on the API that they have come from.

ServiceDispatch Field Mappings

When a Appointment Search API call results in an appointment search being directed to ServiceDispatch, some of the fields that are present in the Appointment Offer Object (below) will come from ServiceDispatch.

As a result, the definition of these fields depends on the ServiceDispatch response.

Please speak with the ServicePower customer services team for the field definitions.

ServiceScheduling Field Mappings

When a Appointment Search API call results in an appointment search being directed to ServiceScheduling, some of the fields that are present in the Appointment Offer Object (below) will come back from ServiceScheduling.

As a result, the definition of these fields depends on the ServiceScheduling response.

Please see the appropriate version of the ServiceScheduling sp:ApptOfferRequest API for the field definitions.

PropertyType
Required?
LengthDescription
Field Mappings
ServiceDispatchServiceScheduling
Providers
arrayYes
Array
Top level array containing one more more objects, containing appointment offers and associated information.

objectMandatory object, containing the Info object, Offers array, and Result object.


Property
Yes
TypeDescription
Infoobject
Yes
Mandatory object, containing details which describe which system and system servicer (if relevant) is supplying the appointment offers described in the parent object.


PropertyTypeDescription
Name
Yes-
string

SD Field: SvcrCollection[].SvcrName

SS Field: SysConfg.Scheduler.ExtId

/

.Id

Src
YesYes
string

One of:

  • SD: If the system supplying the appointment offers is ServiceDispatch.
  • SS: If the system supplying the appointment offers is ServiceScheduling.
  • External: If the system supplying the appointment offers is some other system.
Offers
array
ArrayMandatory array of one or more appointment offer details objects.
object


PropertyType
Yes
Description
OfferToken
---
string

SD Field: OfferToken

SS Field: offerToken

OfferText
---
stringSS Field: offerText
StartDate
---SchdDelDate + 
DateTime

For ServiceScheduling, the value in the StartDate will be returned in UTC format but will actually represent customer local time.

SD Field: SchdDelDate + TimePeriod[0]

SS Field: start

EndDate
---
DateTime

For ServiceScheduling, the value in the StartDate will be returned in UTC format but will actually represent customer local time.

SD Field: SchdDelDate + TimePeriod[1]

SS Field: end

PromBand
---

SS Field: promBand
PromType
---

SS Field: promType
TravelTime
---

SS Field: travelTime
Day
---

SS Field: day
Resultobject
No
Optional object, containing the ServiceScheduling response's more field, when relevant and present.


PropertyTypeDescription
Moreboolean
--
SS Field: more