getAppointmentRequest

Service Modules > Scheduling and Optimization > Schedule Optimization > Schedule Optimization APIs > Appointment Booking APIs > getAppointmentRequest

Endpoint

The endpoint for this API is https://<hostname>:<port>//optimax/eco/v2/schedule-services/getAppointmentOffers.

Description

This API sends the appointment request information for a work order. This is sent when the Get Appointments SFM is clicked for a work order.

Example

The following is an example getAppointmentRequest JSON file.

{
  "workOrder": {
    "workOrderType":"NEW",
    "workOrderId":"WO-00008580",
    "visitDuration":3600.0,
    "serviceTimes": [
      {
        "workingHoursEnd":"2028-09-12T16:00:00.000Z",
        "workingHoursBegin":"2028-09-12T07:00:00.000Z"
        
      }
      
      ],
     "scheduleViolationPenalty":null,
     "requiredProduct":null,
     "requiredExpertise":null,
     "qualifiedTechnicians": [
       
       
     ],
     "priority":21.0,
     "preferredResourcePriority":21.0,
     "preferredResourceId":null,
     "operationType":"add",
     "mandatoryTechnicians": [
       
       
     ],
     "location": {
       "longitude":77.596878,
       "latitude":12.971755
       
     },
     
     "importance":21,
     "bannedTechnicians": [
       
       
     ],
     "address":"Bangalore, 560034, India"
     
   },
  "dispatchProcessId": "a18g0000008M1icAAC",
  "territoryId": "a1jg000000226nIAAQ",
  "orgId": "00Dg0000006Qv56",
  "appointmentOfferType": {
    "arrivalWindows": [
      {
        "startTime":"07:00",
        "endTime":"08:00",
        "arrivalWindowName":"SY_TimeZone2"
        
      },
      {
        "startTime":"08:00",
        "endTime":"09:00",
        "arrivalWindowName":"SY_TimeZone3"
        
      },
      {
        "startTime":"09:00",
        "endTime":"10:00",
        "arrivalWindowName":"SY_TimeZone4"
        
      },
      {
        "startTime":"10:00",
        "endTime":"11:00",
        "arrivalWindowName":"SY_TimeZone5"
        
      },
      {
        "startTime":"11:00",
        "endTime":"12:00",
        "arrivalWindowName":"SY_TimeZone6"
        
      },
      {
        "startTime":"12:00",
        "endTime":"13:00",
        "arrivalWindowName":"SY_TimeZone7"
        
      },
      {
        "startTime":"13:00",
        "endTime":"14:00",
        "arrivalWindowName":"SY_TimeZone8"
        
      },
      {
        "startTime":"14:00",
        "endTime":"15:00",
        "arrivalWindowName":"SY_TimeZone8"
        
      }
      
      ],
     "appointmentOfferTypeName":"SY_Appt_wind"
     
   }
}

Input Description

The following table describes the fields in the getAppointmentRequest JSON. See the sample input data file for examples.

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.
appointmentOfferType	appointmentOfferTypeName	Mandatory	This is the type of the offer appointment.

Was this helpful?