REST Objects Appointment Offer

Appointment Offer Object Format

JSON Format

{
	"Providers": [
		{
			"Info": {
				"Name": "",
				"Src": ""
			},
			"Offers": [
				{
					"OfferToken": "",
					"OfferText": "",
					"StartDate": "",
					"EndDate": "",
					"PromBand": "",
					"PromType": "",
					"TravelTime": "",
					"Day": ""
				},
				...
			],
			"Result": {
				"More": false
			}
		},
		...
	]	
}

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.

Property Type Length Description

Providers

Array

Top level array containing one more more objects, containing appointment offers and associated information.

Property Type Description

Info

object

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

Property Type Description

Name

string

SD Field: SvcrCollection[].SvcrName

SS Field: SysConfg.Scheduler.ExtId.Id

Src

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

Mandatory array of one or more appointment offer details objects.

Property	Type	Description
OfferToken	string	SD Field: OfferToken SS Field: offerToken
OfferText	string	SS Field: offerText
StartDate	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

Result

object

Optional object, containing the ServiceScheduling response's more field, when relevant and present.

Property	Type	Description
More	boolean	SS Field: more