Service Modules > Scheduling and Optimization > Schedule Optimization > Schedule Optimization APIs > Propose Times APIs > Slot Response API
Slot Response API
The response to the Propose Times request API is scheduling slots for the work order, only if the data passed is correct. If the data is incorrect or there is a mismatch, the request returns an error file as response, which contains the reason for failure.
Success Scenario
In the success scenario, the API returns response JSON which contains suitable slots for the work order.
Sample Response JSON
The following is an example response JSON file.
{
	"jobInstanceId": 205015,
	"proposedSlotElement": {
		"id": "eaa1c902-ba5f-4c3c-ae3b-f473abf73c69",
		"resolvedLatitude": 13.013039588928223,
		"resolvedLongitude": 77.62618255615235,
		"slots": [
			{
				"resource": "3d1dae0d-414a-45c2-8c53-fd4dbfa8b897",
				"startTime": "2025-08-26T08:33:00Z",
				"driveDuration": "PT6M",
				"driveDistance": "4633.266688269639 m",
				"arrivalTime": "2025-08-26T08:39:00Z",
				"idleDuration": "PT0S",
				"serviceDuration": "PT1H",
				"endTime": "2025-08-26T09:39:00Z",
				"category": "RECOMMENDED"
			},
			{
				"resource": "3d1dae0d-414a-45c2-8c53-fd4dbfa8b897",
				"startTime": "2025-08-28T06:30:00Z",
				"driveDuration": "PT0S",
				"driveDistance": "0.38656005738849086 m",
				"arrivalTime": "2025-08-28T06:30:00Z",
				"idleDuration": "PT0S",
				"serviceDuration": "PT1H",
				"endTime": "2025-08-28T07:30:00Z",
				"category": "OK"
			},
			{
				"resource": "3d1dae0d-414a-45c2-8c53-fd4dbfa8b897",
				"startTime": "2025-08-27T04:30:00Z",
				"driveDuration": "PT0S",
				"driveDistance": "0.38656005738849086 m",
				"arrivalTime": "2025-08-27T04:30:00Z",
				"idleDuration": "PT10H",
				"serviceDuration": "PT1H",
				"endTime": "2025-08-27T05:30:00Z",
				"category": "OK"
			}
		]
	},
	"exceptionMsgCode": 0,
	"warningMsgCode": 0,
	"createdDateTime": "2025-08-25T07:36:52.384962966Z"
}
Field Descriptions
The following table describes the fields in the Slot Response JSON. See the sample response JSON file for examples.
Element Type
Field
Description
jobInstanceId
This is the job reference ID.
proposedSlotElement
id
This is the work order ID.
resolvedLatitude
This is the latitude coordinate of the work order location.
resolvedLongitude
This is the longitude coordinate of the work order location.
slots
This is the available slot information for the work order.
The following information is provided for each available slot:
• resource: Name of the technician.
• startTime: Start time of the drive to reach the work order location.
• driveDuration: Driving time needed for this slot from the technician's current location.
• driveDistance:
• arrivalTime: Technician arrival time for this work order.
• idleDuration: Technician idle time, if any. If the technician arrival time is earlier than the start time for the slot, there is idle time.
• serviceDuration: Service duration
for the work order.
• endTime: End time of the slot for the work order.
• category: Category of the slot. Possible values are RECOMMENDED, OK, and POOR.
exceptionMsgCode
This is the message code for the exception message. In the success scenario, the message code is always 0.
createdDateTime
This is the date and time at which the response JSON was created.
Failure Scenario
In the failure scenario, a validation error file is returned. It means that the optimizer rejects the Propose Times input and does not run the job.
Sample Response JSON
The following is an example error response JSON file.
{
  "jobInstanceId":10757,
  "proposedSlotElement": {
    "id":"WorkOrder-1"
  },
  "violations": [
    {"code":-120,
     "message":"Hard constraint is violated"
    }
  ],
  "exceptionMsg":"Failed to get appointment offers",
  "exceptionMsgCode":-7,
  "createdDateTime":"2021-09-29T07:23:35.971Z"
}
Field Descriptions
The following table describes the fields in the error validation JSON. See the sample response JSON file for examples.
Field
Description
Notes
jobInstanceId
This is the j
ob reference ID.
proposedSlotElement
This is the Work Order ID.
violations
The list of violations due to which no proposals or slots are found for work order.
• code – Violation code
• message – Violation message corresponding to code
exceptionMsg
This is the e
rror message that indicates the reason for which scheduling was not performed for the work order.
For the list of error codes and corresponding error messages, see Error Codes and Messages.
exceptionMsgCode
This is the e
rror message code.
createdDateTime
This is the d
ate and time when the response JSON was created.
Error Codes and Messages
For the list of error codes and messages, see Error Codes and Messages.
Was this helpful?