Dates Prévisionnelles

Récupérer la date prévisionnelle d'éligibilité FTTH à une adresse

Cette API permet d'obtenir des infos sur l'éligibilité prévisionnelle (FTTH) quand aucun code immeuble n'est connu à l'adresse. Cet appel est prévu pour être utilisé après un retour vide de v2/eligibility/buildings/?kosc_street_code=X&street_number=Y&street_extension=Z avec les mêmes paramètres.

Pour récupérer la date prévisionnelle à une adresse, faire un GET sur l'url /api/v2/eligibility/forecast_eligibility/.

Paramètres

Nom du paramètre

Présence

Type

Contrainte

Description

kosc_street_code

Obligatoire

string

Max 11 chars

Identifiant Kosc de la voie (à récupérer ici)

street_number

Obligatoire

string

Max 7 chars

Numéro de rue (à vérifier ici)

Réponse

Le résultat de l'appel est un dictionnaire.

Exemple

GET /api/v2/eligibility/buildings/?street_number=5b&kosc_street_code=130816920 HTTP/1.1
Host: extranet.kosc-telecom.fr
HTTP/1.1 200 OK
Content-Type: application/json

   {
       "address": {
           "street_number": "5B",
           "street_name": "AVENUE DE LA PLANTADE",
           "kosc_street_code": "130816920",
           "kosc_insee_code": "13081",
           "city": "ROGNAC"
       },
       "message_elig_code": "FIBER_NOT_YET_DEPLOYED",
       "message_elig_text_fr": "Votre Quartier sera commercialisable chez Covage à partir de",
       "message_elig_text_en": "Votre Quartier sera commercialisable chez Covage à partir de",
       "message_elig_date": "2023"
   }

Erreurs

HTTP code

Message

400

Invalid input

500

Unable to serve your request