Appointments¶

For the creation of an xDSL or FttH line, an appointment must be set.

Covage allows you to list the available time slots and make a reservation.

Note

If orders are placed via API, the appointment is optional, on all FttH products.

Listing the available time slots¶

To retrieve the list of available time slots, you can do GET on the /api/v2/appointment/slots/ URL.

If an order has already been created¶

The following parameters can be provided to the API:

Parameter name	Type	Mandatory	Description
order_uuid	query param	Yes	`order` identifier
start_date	query param	No	Search start date
end_date	query param	No	Search end date
level	query param	No	Level type: `standard` (default) or `premium`

If no order has been created yet¶

Note

This API (said v2) replaces API v1, now deprecated. Parameters kosc_insee_code and kosc_street_code replace parameters insee_code and rivoli_code to be compatible with eligibility API.

The following parameters can be provided to the API:

Parameter name	Type	Mandatory	Description
building_ref	query param	Conditional	- `FttH` only : Strongly recommended, but not required
endpoint_ref	query param	Conditional	- `xDSL` : Reference of the `endpoint` (mandatory) - `FttH` (deprecated) : This parameter is deprecated and will be removed. Please use the `building_ref` parameter instead
kosc_insee_code	query param	Yes	`endpoint` kosc insee code (from eligibility)
kosc_street_code	query param	Yes	`endpoint` kosc rivoli code (from eligibility)
product_code	query param	Yes	Selected product code
start_date	query param	No	Search start date
end_date	query param	No	Search end date
level	query param	No	Level type: `standard` (default) or `premium`

Appointment dates¶

For xDSL, the date ranges where you can book an appointment depend on the service level.

standard: start_date = request date + 8 days | end_date = request date + 26 days
premium: start_date = request date + 6 days | end_date = request date + 26 days

For FttH, date ranges are:

start_date = request date + 12 days
end_date = request date + 40 days

Response¶

The API response is a dictionary containing the list of available time slots.

Field name	Type	Description
available_slots	dictionary list	List of available time slots
postponed	boolean	Availability of a postponed appointment (xDSL only)

`available_slots` field¶

The available_slots field contains a list of dictionaries that represent the available time slots.

Field name	Type	Description
start_date	string	Appointment start date
end_date	string	Appointment end date
slot_id	string	Id to be used when booking an appointment (FTTH AI only)
orange_ui_code	string	Id provided by the local loop operator to be used when booking an appointment (sDSL only)

xDSL Example¶

Request:

GET /api/v2/appointment/slots/?endpoint_ref=0472078025&kosc_insee_code=06036&kosc_street_code=06036109P0&product_code=AM01&start_date=2019-06-16T00:00:00Z&end_date=2019-06-17T18:00:00Z&level=standard HTTP/1.1
Host: extranet.kosc-telecom.fr

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "available_slots": [
    {
      "start_date": "2017-06-17T12:00:00Z",
      "end_date": "2017-06-17T14:00:00Z",
      "orange_ui_code": "EH1"
    },
    {
      "start_date": "2017-06-17T12:30:00Z",
      "end_date": "2017-06-17T14:30:00Z",
      "orange_ui_code": "EH1"
    },
    {
      "start_date": "2017-06-17T13:00:00Z",
      "end_date": "2017-06-17T15:00:00Z",
      "orange_ui_code": "EH1"
    },
  ],
  "postponed": false
}

FttH Example¶

Request:

GET /api/v2/appointment/slots/?kosc_insee_code=06036&kosc_street_code=06036109P0&product_code=FP01 HTTP/1.1
Host: extranet.kosc-telecom.fr

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "available_slots": [
    {
      "start_date": "2021-06-17T06:00:00Z",
      "end_date": "2021-06-17T10:00:00Z"
    },
    {
      "start_date": "2021-06-17T12:00:00Z",
      "end_date": "2021-06-17T16:00:00Z"
    },
    {
      "start_date": "2021-06-18T06:00:00Z",
      "end_date": "2021-06-18T10:00:00Z"
    },
    {
      "start_date": "2021-06-18T12:00:00Z",
      "end_date": "2021-06-18T16:00:00Z"
    }
  ]
}

FttH AI Example¶

Request:

GET /api/v2/appointment/slots/?kosc_insee_code=06036&kosc_street_code=06036109P0&product_code=FP04 HTTP/1.1
Host: extranet.kosc-telecom.fr

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "available_slots": [
    {
      "start_date": "2021-06-17T06:00:00Z",
      "end_date": "2021-06-17T10:00:00Z",
      "slot_id": "38-191-6096-20210617"
    },
    {
      "start_date": "2021-06-17T12:00:00Z",
      "end_date": "2021-06-17T16:00:00Z",
      "slot_id": "38-191-6097-20210617"
    },
    {
      "start_date": "2021-06-18T06:00:00Z",
      "end_date": "2021-06-18T10:00:00Z",
      "slot_id": "38-191-6098-20210618"
    },
    {
      "start_date": "2021-06-18T12:00:00Z",
      "end_date": "2021-06-18T16:00:00Z",
      "slot_id": "38-191-6099-20210618"
    }
  ]
}

Booking or modifying an appointment¶

To book or modify an appointment, you must do PUT on the /api/v2/orders/{order_uuid}/appointment/ URL.

The following parameters can be provided to the API:

Parameter name	Type	Mandatory	Description
start_date	string	Yes	Appointment start date
end_date	string	Yes	Appointment end date
slot_id	string	Yes	Conditional (mandatory for FTTH AI)
orange_ui_code	string	Yes	Conditional (mandatory for Copper Orange)
level	string	No	Level type: `standard` (default) or `premium`
postponed	boolean	No	Default: False - Postponed appointment (xDSL only)
comment	string	No	Comment on the appointment sent to the local loop operator

Request (xDSL):

PUT /api/v2/orders/6d1f0d8a-de30-465b-b2f8-8a324e1c9398/appointment/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
  "start_date": "2017-06-17T12:00:00Z",
  "end_date": "2017-06-17T14:00:00Z",
  "level": "standard",
  "postponed": false,
  "orange_ui_code": "EH1",
  "comment": "Comments on the appointment go here"
}

Request (FttH):

PUT /api/v2/orders/6d1f0d8a-de30-465b-b2f8-8a324e1c9398/appointment/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
  "start_date": "2019-06-17T12:00:00Z",
  "end_date": "2019-06-17T14:00:00Z",
  "comment": "Comments on the appointment go here"
}

Request (FttH AI):

PUT /api/v2/orders/6d1f0d8a-de30-465b-b2f8-8a324e1c9398/appointment/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
  "start_date": "2019-06-17T12:00:00Z",
  "end_date": "2019-06-17T14:00:00Z",
  "comment": "Comments on the appointment go here"
  "slot_id": "38-191-6099-20190617"
}

Note

The end_customer[contact] parameter of an order must be filled in before booking an appointment.

Note

You can only book or modify an appointment when the order is in the draft state.

Note

Once the appointment is booked, you have 40 hours before it expires. If it does, you will have to book a new appointment.

Note

As long as the order remains in the draft state, you can only modify the appointment two times.

Note

Unlike in GUI, the appointment is optional in API, if you want to use the ERDV (in API), the slot_id field is mandatory.

Retrieving an appointment¶

To retrieve the appointment associated with an order, you can do GET on the /api/v2/orders/{order_uuid}/appointment/ URL.

There are two types of appointments:

The erdv type is used when you book an appointment.
The fixed-erdv type is used when the local loop operator sets the appointment.

The API response is a dictionary.

Field name	Type	Description
type	string	Appointment type (`erdv` or `fixed-erdv`)
start_date	string	Appointment start date
end_date	string	Appointment end date
level	string	Level type (`standard` or `premium`)
status	string	Appointment state (`initialized`, `postponed`, `confirmed` or``canceled``)
provider_appoint_ref	string	Reference of the appointment with the local loop operator (copper)
erdv_id	string	Reference of the appointment (FTTH AI)
comment	string	Comments on the appointment sent to the local loop operator
creation_date	string	Date of the appointment booking
date	string	Appointment date
time	string	Comments of the local loop operator

Request::

GET /api/v2/orders/6d1f0d8a-de30-465b-b2f8-8a324e1c9398/appointment/ HTTP/1.1
Host: extranet.kosc-telecom.fr

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "type": "erdv",
    "start_date": "2017-06-17T12:00:00Z",
    "end_date": "2017-06-17T14:00:00Z",
    "level": "standard",
    "status": "initialized",
    "provider_appoint_ref": "R10-DGT-19667000-0200000001000-ERDV",
    "comment": "Comments on the appointment"
    "creation_date": "2017-06-07T14:12:06.149000"
}

Request:

GET /api/v2/orders/6d1f0d8a-de30-465b-b2f8-8a324e1c9398/appointment/ HTTP/1.1
Host: extranet.kosc-telecom.fr

Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "type": "fixed-erdv",
    "date ": "20170617",
    "time": "10:00 -12:00 a.m.",
    "status": "initialized",
}

Canceling an appointment¶

To cancel an appointment associated with an order, you can do DELETE on the /api/v2/orders/{order_uuid}/appointment/ URL.

Request:

DELETE /api/v2/orders/6d1f0d8a-de30-465b-b2f8-8a324e1c9398/appointment/ HTTP/1.1
Host: extranet.kosc-telecom.fr

Note

You can only cancel an appointment when the order is in the draft state.

Appointments¶

Listing the available time slots¶

If an order has already been created¶

If no order has been created yet¶

Appointment dates¶

Response¶

available_slots field¶

xDSL Example¶

FttH Example¶

FttH AI Example¶

Booking or modifying an appointment¶

Retrieving an appointment¶

Canceling an appointment¶

`available_slots` field¶