Rendez-vous¶

Lors de la création d'une ligne xDSL ou FttH, un rendez-vous pour une intervention doit être pris.

La plateforme FTTH de Covage vous permet de lister les différents créneaux disponibles et d'en réserver un.

Note

Si la commande est passée en API, le RDV est facultatif sur l'ensemble des produits FttH.

Lister les créneaux disponibles¶

Pour récupérer la liste des créneaux, vous pouvez faire un GET sur l'URL /api/v2/appointment/slots/.

Si une commande a déjà été créée¶

Les paramètres suivants peuvent être fournis à l'API :

Nom du paramètre	Type	Obligatoire	Description
order_uuid	query param	Oui	Identifiant de l'`order`
start_date	query param	Non	Date de début de recherche
end_date	query param	Non	Date de fin de recherche
level	query param	Non	Type de level : `standard` (défaut) ou `premium`

Si aucune commande n'a encore été créée¶

Note

Cette API (dite v2) remplace l'API v1, désormais obsolète. Les paramètres kosc_insee_code et kosc_street_code remplacent les paramètres insee_code et rivoli_code pour être utilisables avec l'API d'éligibilité.

Les paramètres suivants peuvent être fournis à l'API :

Nom du paramètre	Type	Obligatoire	Description
building_ref	query param	Fibre : obligatoire. Cuivre : non	- `FttH` uniquement : obligatoire
endpoint_ref	query param	Fibre : non. Cuivre : obligatoire	- `Cuivre` : Référence de l'`endpoint` (obligatoire) - `FttH` Veuillez utiliser à la place le paramètre `building_ref`
kosc_insee_code	query param	Oui	Code INSEE Covage de l'`endpoint` (récupéré via l'éligibilité)
kosc_street_code	query param	Oui	Code de rue Covage de l'`endpoint` (récupéré via l'éligibilité)
product_code	query param	Oui	Code produit choisi
start_date	query param	Non	Date de début de recherche
end_date	query param	Non	Date de fin de recherche
vt	query param	Non	Fibre uniquement : visite technique (`vt_simple` ou `vt_complexe`)
otp ou pto	query param	Non	Fibre uniquement : référence de la PTO
level	query param	Non	Cuivre uniquement : type de level : `standard` (défaut) ou `premium`

Il existe 4 types d'erdv : création, écrasement (activate_defined), visite technique simple et visite technique complexe.

Le type d'erdv est déterminé en fonction du code produit, de la clef vt et du pto/otp.

Si le code produit correspond à un produit confort, alors l'erdv est de type visite technique complexe.

Si le paramètre vt est spécifié avec une des 2 valeurs admises, alors l'erdv est de type correspondant (visite technique simple / visite technique complexe).

Enfin, le paramètre otp/pto permet de sélectionner un erdv de type écrasement, à condition qu'aucun des cas précédents ne soit activé et que la pto existe.

Dates de rendez-vous¶

Dans le cas du cuivre, l'intervalle durant lequel un rendez-vous peut être pris dépend du niveau de service.

standard: start_date = date de la requête + 8 jours | end_date = date de la requête + 26 jours
premium: start_date = date de la requête + 6 jours | end_date = date de la requête + 26 jours

Dans le cas FttH, les intervalles sont traités ainsi : il existe, selon le produit et la localisation, un intervalle par défaut. start_date et end_date sont donc optionnels. Si l'un ou l'autre est spécifié, l'intervalle résultant sera automatiquement ajusté pour rester inclus dans l'intervalle par défaut.

Réponse¶

La réponse de l'API est un dictionnaire contenant la liste des créneaux disponibles.

Nom du champ	Type	Description
available_slots	liste de dictionnaires	Liste des créneaux disponibles
postponed	boolean	Disponibilité de rendez-vous différé (cuivre uniquement)

Champ `available_slots`¶

Le champ available_slots contient une liste de dictionnaires représentant les créneaux disponibles.

Nom du champ	Type	Description
start_date	string	Date de début de rendez-vous
end_date	string	Date de fin de rendez-vous
slot_id	string	Identifiant à utiliser lors d'une prise de rendez-vous (Fibre, lorsque fourni)
orange_ui_code	string	Identifiant fourni par l'opérateur de boucle locale à utiliser lors d'une prise de rendez-vous (cuivre uniquement)

Exemple Cuivre¶

Requête :

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

Réponse :

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

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

Exemple FttH eRDV (type 1)¶

Requête :

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

Réponse :

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"
    }
  ]
}

Exemple FttH RDV souhaité (type 2)¶

Requête :

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

Réponse :

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"
    }
  ]
}

Note

Le format du slot_id est non spécifié et dépend de la zone géographique. Ce champ peut avoir jusqu'à 80 caractères.

Note

Le fait d'avoir une réponse de type 1 ou 2 dépend de la disponibilité du type 1.

Réserver ou modifier un rendez-vous¶

Pour réserver ou modifier un rendez-vous, vous devez faire un PUT sur l'url /api/v2/orders/{order_uuid}/appointment/.

Note

Vous ne pouvez réserver ou modifier un rendez-vous que si l'order est dans un statut draft.

Note

Le paramètre end_customer[contact] d'un order doit être renseigné avant réservation d'un rendez-vous.

Les paramètres suivants peuvent être fournis à l'API :

Nom du paramètre	Type	Obligatoire	Description
start_date	string	Oui	Date de début de rendez-vous
end_date	string	Oui	Date de fin de rendez-vous
slot_id	string	Conditionnel (obligatoire pour FTTH eRDV)	Fourni par la réponse de type 1
orange_ui_code	string	Conditionnel (obligatoire pour cuivre Orange)	Code Orange
level	string	Non	Type de level : `standard` (défaut) ou `premium` (cuivre uniquement)
postponed	boolean	Non	Défaut: False - Rendez-vous différé (cuivre uniquement)
comment	string	Non	Commentaire sur le rendez-vous transmis au sous-traitant

Requête (Cuivre) :

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",
  "level": "standard",
  "postponed": false,
  "orange_ui_code": "EH1",
  "comment": "Ici le commentaire en rapport avec le rendez-vous"
}

Requête (FttH eRDV) :

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": "Ici le commentaire en rapport avec le rendez-vous",
  "slot_id": "38-191-6099-20190617",
  "status": "confirmed",
  "booking_date": "202019-06-10:25:09.021719Z"
}

Requête (FttH RDV souhaité) :

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": "Ici le commentaire en rapport avec le rendez-vous"
}

Note

Dès que le rendez-vous est réservé, vous disposez d'une période de 40 heures avant que celui-ci n'expire. Vous devrez alors en réserver un nouveau.

Récupérer un rendez-vous¶

Pour récupérer le rendez-vous d'un order, vous pouvez faire un GET sur l'url /api/v2/orders/{order_uuid}/appointment/.

La réponse de l'API est un dictionnaire.

Nom du champ	Type	Description
type	string	Type du rendez-vous (`erdv`)
start_date	string	Date de début du rendez-vous
end_date	string	Date de fin du rendez-vous
level	string	Type de level (`standard` ou `premium`) (cuivre uniquement)
status	string	Status du rendez-vous (`initialized`, `postponed`, `confirmed` ou `cancelled`)
provider_appoint_ref	string	Référence du rendez-vous auprès de l'opérateur de boucle locale (Cuivre)
erdv_id	string	Référence du rendez-vous (FTTH eRDV)
comment	string	Commentaire sur le rendez-vous
creation_date	string	Date de la prise de rendez-vous

Requête :

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

Réponse (cuivre) :

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

{
    "type": "erdv",
    "start_date": "2019-06-17T12:00:00Z",
    "end_date": "2019-06-17T14:00:00Z",
    "level": "standard",
    "status": "confirmed",
    "provider_appoint_ref": "R10-DGT-19667000-0200000001000-ERDV",
    "comment": "Commentaire en rapport avec le rendez-vous",
    "creation_date": "2019-06-07T14:12:06.149000"
}

Réponse (eRDV Fibre) :

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

{
    "type": "erdv",
    "start_date": "2019-06-17T12:00:00Z",
    "end_date": "2019-06-17T14:00:00Z",
    "erdv_id": "38-191-6097-20210617",
    "status": "confirmed",
    "comment": "Commentaire en rapport avec le rendez-vous",
    "creation_date": "2019-06-07T14:12:06.149000"
}

Annuler un rendez-vous¶

Pour annuler un rendez-vous sur un order, vous pouvez faire un DELETE sur l'url /api/v2/orders/{order_uuid}/appointment/.

Requête :

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

Note

Vous ne pouvez annuler un rendez-vous que si la commande est dans un statut draft.

Rendez-vous¶

Lister les créneaux disponibles¶

Si une commande a déjà été créée¶

Si aucune commande n'a encore été créée¶

Dates de rendez-vous¶

Réponse¶

Champ available_slots¶

Exemple Cuivre¶

Exemple FttH eRDV (type 1)¶

Exemple FttH RDV souhaité (type 2)¶

Réserver ou modifier un rendez-vous¶

Récupérer un rendez-vous¶

Annuler un rendez-vous¶

Champ `available_slots`¶