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 les commandes sont passés 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	Conditionnel	- `FttH` uniquement : Fortement recommandé, mais non obligatoire
endpoint_ref	query param	Conditionnel	- `Cuivre` : Référence de l'`endpoint` (obligatoire) - `FttH` (déprécié) : Ce paramètre est déprécié et sera supprimé. 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
level	query param	Non	Type de level : `standard` (défaut) ou `premium`

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 les suivants:

start_date = date de la requête + 12 jours
end_date = date de la requête + 40 jours

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¶

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

Exemple FttH AI¶

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

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/.

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	Oui	Conditionnel (obligatoire pour FTTH AI)
orange_ui_code	string	Oui	Conditionnel (obligatoire pour cuivre Orange)
level	string	Non	Type de level : `standard` (défaut) ou `premium`
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) :

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

Requête (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": "Ici le commentaire en rapport avec le rendez-vous",
  "slot_id": "38-191-6099-20190617"
}

Note

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

Note

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

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.

Note

Tant que l'order est en statut draft, vous ne pouvez changer le rendez-vous que deux fois.

Note

Contrairement en IHM, le rendez-vous est facultatif en API, si vous souhaitez utiliser le ERDV (en API), le champ slot_id est bien obligatoire.

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/.

Il existe deux types de rendez-vous :

Le type erdv qui est utilisé quand vous réservez un rendez-vous,
Le type fixed-erdv qui est utilisé quand l'opérateur de boucle locale force le rendez-vous.

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

Nom du champ	Type	Description
type	string	Type du rendez-vous (`erdv` ou `fixed-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`)
status	string	Status du rendez-vous (`initialized`, `postponed`, `confirmed` ou `canceled`)
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 AI)
comment	string	Commentaire sur le rendez-vous transmis à l'opérateur de boucle locale
creation_date	string	Date de la prise de rendez-vous
date	string	Date du rendez-vous
time	string	Commentaire de l'opérateur de boucle locale

Requête :

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

Réponse :

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": "initialized",
    "provider_appoint_ref": "R10-DGT-19667000-0200000001000-ERDV",
    "comment": "Commentaire en rapport avec le rendez-vous",
    "creation_date": "2019-06-07T14:12:06.149000"
}

Requête :

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

Réponse :

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

{
    "type": "fixed-erdv",
    "date ": "20190617",
    "time": "10h-12h",
    "status": "initialized",
}

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¶

Exemple FttH AI¶

Réserver ou modifier un rendez-vous¶

Récupérer un rendez-vous¶

Annuler un rendez-vous¶

Champ `available_slots`¶