|
Input Type
|
Field
|
Mandatory or Optional?
|
Description
|
Notes
|
|---|---|---|---|---|
|
workOrder
|
workOrderType
|
Mandatory
|
This is the type of the work order.
|
|
|
workOrderId
|
Mandatory
|
This is the work order number.
|
||
|
visitDuration
|
Mandatory
|
This is the service duration for the work order.
|
||
|
serviceTimes
|
Mandatory
|
These are the service times or horizon for the work order.
These must be provided in the pairs of workingHoursEnd and workingHoursBegin field values.
|
||
|
scheduleViolationPenalty
|
Optional
|
This is the p
penalty that is applied for violating a scheduled time for a work order.
|
||
|
requiredProduct
|
Optional
|
This is the product serviced for the work order.
|
||
|
requiredExpertise
|
Optional
|
This is the required skill for the work order.
|
||
|
qualifiedTechnicians
|
Optional
|
This is the list of qualified technicians for the work order.
|
||
|
priority
|
Mandatory
|
This is the dispatch process priority.
|
||
|
preferredResourcePriority
|
Optional
|
This is the preferred technician priority, if any.
|
||
|
preferredResourceId
|
Optional
|
This is the preferred technician ID.
|
||
|
operationType
|
Mandatory
|
This is the type of the operation.
In this case, operation type is Add because a new record is being added.
|
Field value options are Add, Update, and Remove.
|
|
|
mandatoryTechnicians
|
Optional
|
This is the mandatory technician ID, if any, amongst the qualified technicians.
|
||
|
location
|
Mandatory
|
This is the location of the work order, in latitude-longitude pair values.
|
Either location or address values are mandatory. If one is present, then the other is optional.
|
|
|
importance
|
Mandatory
|
This is field value should be set to the same value as the Priority field value.
|
||
|
bannedTechnicians
|
Optional
|
This field value should be the list of banned technicians' IDs, if any, amongst qualified technicians.
|
||
|
address
|
Optional
|
This is the address of the work order.
|
Either location or address values are mandatory. If one is present, then the other is optional.
|
|
|
dispatchProcessId
|
Mandatory
|
This is the d
dispatch process ID.
|
||
|
territoryId
|
Mandatory
|
This is the t
territory ID.
|
||
|
orgId
|
Mandatory
|
This is the
Salesforce org ID.
|
||
|
appointmentOfferType
|
arrivalWindows
|
Mandatory
|
These are the arrival windows for the work order.
These must be provided in the pairs of startTime, endTime, and arrivalWindowName field values.
|
|
|
appointmentOfferTypeName
|
Mandatory
|
This is the type of the offer appointment.
|