Appointment Search Object Format
| Include Page | ||||
|---|---|---|---|---|
|
Appointment Search Object Properties
Field Mappings
REST Work Item Appointment Search calls may result in an appointment search request being directed to either a ServiceDispatch system, a ServiceScheduling system, or both. (See the REST Work Item Appointment Search definition for details on how this is configured).
As a result, all of the fields in the Appointment Service Object are passed through to ServiceDispatch and/or ServiceScheduling, which means that the field definitions depend on the API that they are passed to.
In addition, fields may, or may not be, mandatory, depending on the system(s) to which they are passed, with the exception of some fields which are mandated by ServiceBroker itself (and which are marked below).
ServiceDispatch Field Mappings
When an REST Work Item Appointment Search call results in an appointment search request being directed to ServiceDispatch, the fields that are present in the Appointment Search Object (below) with a ServiceDispatch field mapping will be passed to ServiceDispatch.
As a result, the definition of these fields depends on how ServiceDispatch handles the fields.
Please speak with the ServicePower customer services team for the field definitions.
ServiceScheduling Field Mappings
When an REST Work Item Appointment Search call results in an appointment search request being directed to ServiceScheduling, the fields that are present in the Appointment Search Object (below) with a ServiceScheduling field mapping will be passed to ServiceScheduling.
As a result, the definition of these fields depends on how ServiceScheduling handles the fields.
Please see the appropriate version of the ServiceScheduling sp:ApptOfferRequest API for the field definitions.
| Property | Type | Required? | Description | Field Mappings | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceDispatch | ServiceScheduling | |||||||
Band | object | No | Optional field container object. | - | - | |||
Start | - | N/A | band.start | |||||
End | - | N/A | band.end | |||||
TimeBandID | - | N/A | band.timeBandID | |||||
CapacityCategory | - | The capacity of the category. | N/A | capacityCategory | ||||
Days | - | The days available. | N/A | days | ||||
DeliverySize | -pending | The size of the delivery. | c | deliverySize | ||||
EndDate | DateTime | -pending | The scheduled end date/ | (End.Date+Time - Start.Date+Time) --> SearchProcedure.NoDays | end.date + end.time | |||
ExtraDuration | - | pending |
| extraDuration | ||||
ExtraOverhead | - | - | N/A | extraOverhead | ||||
ExtraSkills | array | No | Optional array, containing one or more field container objects. | - | - | |||
SkillID | - | - | ExtraSkills.SkillId | extraSkills.reqSkills[].skillID | ||||
SkillLevel | - | - | ExtraSkills.SkillLevel | extraSkills.reqSkills[].skillLevel | ||||
Mfg | - | - |
| |||||
ProdLine | - | - |
| |||||
ServiceType | - | - |
| |||||
WarrantyType | - | - |
| |||||
ForceOptions | object | No | Optional field container object. | |||||
IgnoreCapacity | - | - | forceOptions.IgnoreCapacity | |||||
IgnoreOverlap | - | - | forceOptions.IgnoreOverlap | |||||
InTray | - | - | forceOptions.InTray | |||||
InTrayWithSkill | - | - | forceOptions.InTrayWithSkill | |||||
NoLocalKnowledge | - | - | forceOptions.NoLocalKnowledge | |||||
NoTravel | - | - | forceOptions.NoTravel | |||||
Reassign | - | - | forceOptions.Reassign | |||||
SpareForceGo | - | - | forceOptions.SpareForceGo | |||||
GroupID | - | - | groupID | |||||
Importance | - | - | importance | |||||
Index | - | - | index | |||||
ReqProvider | array | No | Optional array, containing one or more field container objects. | |||||
object | No | |||||||
Id | - | - |
| listReqEmps.reqEmp[].empID | ||||
MPX | - | - | listReqEmps.reqEmp[].MPX | |||||
Location | object | Yes | Mandatory field container object. | |||||
Latitude | - | - | latitude | |||||
Longitude | - | - | longitude | |||||
Postcode | Yes | - | ProductLocation.Postcode | postcode | ||||
Country | - | - | ProductLocation.Country | |||||
SiteID | - | - | ProductLocation.SiteID | siteID | ||||
MaxOffers | - | - |
| numReq | ||||
NumReqTypes | - | - | numReqType | |||||
OfferOptions | object | No | Optional field container object. | |||||
AllowEmptOT | - | - | offerOptions.AllowEmpOT | |||||
ConsecShift | - | - | offerOptions.ConsecShift | |||||
ContigShift | - | - | offerOptions.ContigShift | |||||
DupUseEmpID | - | - | offerOptions.DupUseEmpID | |||||
NonConsecShift | - | - | offerOptions.NonConsecShift | |||||
OfferTextCost | - | - | offerOptions.OfferTextCost | |||||
OfferTextEmpID | - | - | offerOptions.OfferTextEmpID | |||||
SpareIgnVanStock | - | - | offerOptions.SpareIgnVanStock | |||||
UseExtraDuration | - | - | offerOptions.useExtraDuration | |||||
PickupSize | - | - | pickupSize | |||||
PreferredDate | - | - | preferredDate | |||||
Part | array | No | Optional array, containing one or more field container objects. | |||||
object | No | |||||||
VendorId | - | - | ||||||
VendorName | - | - | ||||||
Id | - | - | ||||||
Type | - | - | ||||||
Qty | - | - | ||||||
Product | object | No | Optional field container object. | |||||
Mfg | - | - | ProductInfo.BrandCode | |||||
ProdLine | - | - | ProductInfo.ProductCode | |||||
PromSet | - | - | promSet | |||||
RankingCutoff | - | - | RankingCutoff | |||||
ReqUnit | object | No | Optional field container object. | |||||
RUID | - | - | reqUnit.RUID | |||||
UnitType | - | - | reqUnit.unitType | |||||
SearchProcedure | object | No | Optional field container object. | |||||
ProcedureCode | - | - | SearchProcedure.ProcedureCode | |||||
ElementAttributes | array | No | Optional array, containing one or more field container objects. | |||||
object | No | |||||||
Name | - | - |
| |||||
Value | - | - | SearchProcedure.ElementAttributes[].Value | |||||
StartDate | DateTime | - | - | SearchProcedure.StartDate | start.date + start.time | |||
SortBy | - | - |
| |||||
StdExtraDuration | - | - | stdExtraDuration | |||||
WarrantyType | - | - | WarrantyType | |||||
WorkType | object | Yes | Mandatory field container object. | |||||
Name | Yes | - | ServiceType | jobType | ||||