Endpoints¶

Avertissement

Cette version de l'API d'éligibilité est dépréciée et sera prochainement désactivée. Elle ne doit en aucun cas être utilisée pour de nouveaux développements. Vous êtes invités à migrer vers l'API d'éligibilité v2.

Lister les endpoints d'une adresse¶

Pour rechercher un endpoint par adresse, vous pouvez lister les endpoints en faisant un GET sur l'url /api/eligibility/endpoints/ avec le paramètre ?by=address ainsi que quelques paramètres supplémentaires.

Paramètres¶

Nom du champ	Type	Obligatoire	Description
insee_code	string	Oui	Code insee
rivoli_code	string	Oui	Code rivoli
inactive	boolean	Non	Rechercher un numéro de ligne inactif
city	string	Non	Nom de la ville
street_number	string	Non	Numéro de rue
building	string	Non	Identifiant du batiment
stairs	string	Non	Identifiant de l'escalier
floor	string	Non	Numéro de l'étage

Réponse¶

L'api renverra une liste d'endpoints (documentation d'un endpoint ici).

Exemple¶

GET /api/eligibility/endpoints/?by=address&street_number=116&rivoli_code=7801&insee_code=75116 HTTP/1.1
Host: extranet.kosc-telecom.fr

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

[
   {
      "endpoint_ref" : "0140500044",
      "endpoint_ref_type" : "line_number",
      "address" : {
         "housing_complex" : "CAR REGIE",
         "owner_name" : "VICTOIRE CLASSIQUE 2017",
         "city" : "PARIS 16",
         "insee_code" : "75116",
         "street_name" : "AV PRESIDENT KENNEDY",
         "rivoli_code" : "7801",
         "street_number" : "00116"
      },
      "concentration_point" : {
         "address" : {
            "insee_code" : "75116",
            "street_name" : "AV PRESIDENT KENNEDY",
            "rivoli_code" : "7801",
            "street_number" : "116",
            "city" : "PARIS 16"
         },
         "latlng" : {
            "latitude" : 48.8521481,
            "longitude" : 2.2795104
         }
      },
      "info" : {
         "inactive" : false,
         "unlisted_number" : false,
         "dti_presence": false,
         "available_pairs": 0,
         "max_available_pairs": 0,
         "under_construction": false
      },
   }
   {
      "endpoint_ref" : "0142305090",
      "endpoint_ref_type" : "line_number",
      "address" : {
         "rivoli_code" : "7801",
         "street_number" : "00116",
         "insee_code" : "75116",
         "street_name" : "AV PRESIDENT KENNEDY",
         "city" : "PARIS 16",
         "owner_name" : "VICTOIRE CLASSIQUE 2017",
         "housing_complex" : "CAR REGIE"
      },
      "concentration_point" : {
         "latlng" : {
            "longitude" : 2.2795104,
            "latitude" : 48.8521481
         },
         "address" : {
            "insee_code" : "75116",
            "street_name" : "AV PRESIDENT KENNEDY",
            "rivoli_code" : "7801",
            "street_number" : "116",
            "city" : "PARIS 16"
         }
      },
      "info" : {
         "inactive" : false,
         "unlisted_number" : false,
         "dti_presence": false,
         "available_pairs": 0,
         "max_available_pairs": 0,
         "under_construction": false
      }
   }
]

Obtenir les informations d'un endpoint donné¶

Faire un appel GET sur l'url /api/eligibility/endpoints/{endpoint_ref}/ vous permet d'obtenir des informations plus détaillées sur un endpoint connu.

Paramètres¶

Nom du champ	Type	Obligatoire	Description
endpoint_ref_type	string	Oui	Le type de l'endpoint (`line_number`)
inactive	boolean	Non	Rechercher un numéro de ligne inactif
include_characteristics	boolean	Non	Inclut les caractéristiques de l'endpoint (nom du NRA, longueurs des sections cuivres, etc.) dans la réponse de l'API.

Note

Si le paramètre inactive n'est pas fourni, il y aura un check sur un endpoint actif et ensuite sur un endpoint inactif, si aucun d'entre eux est trouvé une erreur sera retournée.

Réponse¶

L'api renverra un endpoint (documentation d'un endpoint ici).

Exemple¶

GET /api/eligibility/endpoints/0140500044/?endpoint_ref_type=line_number&include_characteristics=true HTTP/1.1
Host: extranet.kosc-telecom.fr

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

{
  "endpoint_ref": "0140500044",
  "endpoint_ref_type": "line_number",
  "concentration_point": {
    "latlng": {
      "latitude": 48.8521481,
      "longitude": 2.2795104
    },
    "address": {
      "rivoli_code": "7801",
      "insee_code": "75116",
      "street_number": "00116",
      "street_name": "AV PRESIDENT KENNEDY",
      "city": "PARIS 16"
    }
  },
  "info": {
    "inactive": false,
    "unlisted_number": false,
    "available_pairs": 27,
    "max_available_pairs": 112,
    "under_construction": false
  },
  "characteristics": {
    "sections_lengths": [
      {
        "diameter": 5,
        "length": 100
      },
      {
        "diameter": 4,
        "length": 1280
      }
    ],
    "nra": "75116AUT"
  },
  "address": {
    "rivoli_code": "7801",
    "insee_code": "75116",
    "street_number": "00116",
    "street_name": "AV PRESIDENT KENNEDY",
    "city": "PARIS 16",
    "housing_complex": "CAR REGIE",
    "owner_name": "VICTOIRE CLASSIQUE 2017"
  }
}

Gestion des erreurs¶

En cas d'erreur pour les urls /api/eligibility/endpoints/{endpoint_ref}/offers/ et /api/eligibility/endpoints/{endpoint_ref}/, l'API enverra une réponse avec un code HTTP 400. Le champ error contiendra une des erreurs suivantes:

Invalid request - please contact Covage

Incomplete request - please contact Covage

Not allocated line number

Unknown line number

Line number is a System Line Number

Wrong request - please contact Covage

Fictive fiber line number

Endpoint creation forbidden at this address

Local Loop Operator eligibility service is not available

Loop Operator eligibility service is closed

Request error - please contact administrator

Please retry your request in a few seconds

Exemple¶

GET /api/eligibility/endpoints/0101010101/?endpoint_ref_type=line_number HTTP/1.1
Host: extranet.kosc-telecom.fr

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "apirequest_uuid": "KOSC_fb3140c4-2305-4185-952d-2aa5c4c2e0f4",
    "details": null,
    "error": "Unknown line number"
}