Search Available Time Slots

GET /availableTimeSlots

URL Parameters

Parameter	Type	Description
objectId	UUID	The objectId is the UUID that represents the service location. See Object.
workType	String	The workType is the type of work that is being scheduled. This is a string that is defined by the OAP. These will be preshared, such as 'Install' or 'Repair'.
externalId	String	The externalId is the order number from the ISP. Will be included in responses.
startDate	unix timestamp	The startDate is the earliest date that the ISP is looking to schedule work.
endDate	unix timestamp	The endDate is the latest date that the ISP is looking to schedule work.

Example

/searchTimeSlot?fields=objectId=9a24bbb8-fe5f-49ca-b18a-39fbdc59e7fb,workType=Install,externalId=S1234567890,startDate=1715005423,endDate=1715005423

Response

Response will include an array of JSON objects with a start and end time, representing the time window for arrival that the ISP can display to a potential end user for choice.

[
   {
      "searchDate":"2024-01-02T22:47:44.628Z",
      "availableTimeSlot":[
         {
            "validFor":{
               "startDateTime":1715005423,
               "endDateTime":1715005423
            }
         },
         {
            "validFor":{
               "startDateTime":1715005423,
               "endDateTime":1715005423
            }
         }
      ],
      "externalId":"S1234567890"
   }
]