Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 11 Current »

5.0.0

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

On this page:

Related pages:

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.

PropertyTypeLengthDescriptionField Mappings:  ServiceDispatchField Mappings:  ServiceScheduling
ProvidersArray

Top level array containing one more more objects, containing appointment offers and associated information.  Mandatory object, containing details which describe which system and system servicer (if relevant) is supplying the appointment offers described in the parent object.

  • External: If the system supplying the appointment offers is some other system.

For more, see Providers.Offers.Objects.

SvcrCollection[].SvcrNameSysConfg.Scheduler.ExtId.Id
  • No labels