Query Appointment Timeslots

Request

Query Params

dateFrom

string

required

The date to search for appointments from. Must be in yyyy-mm-dd format

orderId

string

required

The OrderID to search appointment timeslots for

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

appointmentRequestId

string

required

appointments

array[object (Appointment) {7}]

required

slotId

string

optional

The ID of the Appointment Timeslot - this ID is used when booking a new appointment

slotType

enum<string>

optional

Type of timeslot. Note: For typical AVC connections, only AM or PM should be selected. Other options may incur additional charges.

Allowed values:

AMPMAHACA

startTime

string

optional

The start time of the appointment timeslot. Start time is returned in UTC timezone format - Timezone offset should be applied to get exact Appointment Time for Customer’s location.

endTime

string <date-time>

optional

The end time of the appointment timeslot. Start time is returned in UTC timezone format - Timezone offset should be applied to get exact Appointment Time for Customer’s location.

timezoneOffset

string

optional

Represents the Timezone offset for the timeslot based on location (different offset will apply depending on state).

leadTime

enum<string>

optional

Indicates the lead time that will be taken to complete an appointment. Note: For typical AVC connections, only Standard slots should be selected. Other options may incur additional charges.

Allowed values:

StandardAcceleratedPriorityAssistReducedLeadTime

withinTimeWindow

boolean

optional

Indicates whether the time slot is within Order SLA or not. Only reliable for Non-'Service Restoration' Demand Types of FTTN and FTTB. For all other technology types, this information is deprecated and can be ignored.

Example

{
    "appointmentRequestId": "string",
    "appointments": [
        {
            "slotId": "string",
            "slotType": "AM",
            "startTime": "string",
            "endTime": "2019-08-24T14:15:22Z",
            "timezoneOffset": "string",
            "leadTime": "Standard",
            "withinTimeWindow": true
        }
    ]
}

🟠403Invalid access