Endpoint

Un endpoint est un objet contenant les informations nécessaires pour identifier de façon précise le type de ligne et sa référence unique. Sa structure est commune à l'API d'éligibilité et à l'API fibre.

Nom du champ	Type	Description
endpoint_ref_type	string	Type d'`endpoint (line_number, otp)
endpoint_ref	string	Identifiant de l'endpoint
address	dict	Adresse de l'endpoint

Champs spécifiques à l'endpoint cuivre

Nom du champ	Type	Description
copper_info	dict	Informations techniques cuivre

Champs spécifiques à l'endpoint fibre

Nom du champ	Type	Description
fiber_info	dict	Informations techniques fibre

Champ address

Nom du champ	Type	Description
kosc_street_code	string	Identifiant Covage de la voie
kosc_insee_code	string	Code INSEE Covage identifiant la commune
street_number	string	Numéro dans la voie
street_name	string	Nom de la voie
city	string	Nom de la commune
stairs	string	Escalier
floor	string	Etage
building	string	Nom du bâtiment

Champs de l'address spécifique à l'endpoint cuivre

Nom du champ	Type	Description
housing_complex	string	Nom de la résidence
door	string	Porte
owner_name	string	Nom du propriétaire de la ligne

Champ copper_info

Nom du champ	Type	Description
status	string	Statut de l'endpoint (active, inactive)
unlisted_number	boolean	Indique si le numéro de téléphone est sur liste rouge
available_pairs	integer	Nombre de paires disponibles au Point de Concentration (PC) de rattachement
max_available_pairs	integer	Nombre de paires disponibles au Point de Concentration (PC) desservant l'adresse et ayant le plus de paires disponibles
under_construction	boolean	Indique si la ligne est en construction
sections_lengths	dict list	Liste des longueurs de cuivre qui composent la ligne
nra	string	Code du NRA attaché à l'endpoint
concentration_point	dict	Informations sur le point de concentration

Champ copper_info.concentration_point

Nom du champ	Type	Description
latlng	dict	Coordonnées géographiques du point de concentration
address	dict	Adresse du point de concentration

Champ copper_info.concentration_point.latlng

Nom du champ	Type	Description
latitude	float	Latitude
longitude	float	Longitude

Le champ concentration_point.address a la même composition que le champ address cité au-dessus à l'exception du champ owner_name.

Champ copper_info.concentration_point.address

Nom du champ	Type	Description
kosc_street_code	string	Identifiant Covage de la voie
kosc_insee_code	string	Code INSEE Covage identifiant la commune
street_number	string	Numéro dans la voie
street_name	string	Nom de la voie
city	string	Nom de la commune

Champs copper_info.sections_lengths

Le champ copper_info.sections_lengths est une liste de dictionnaires représentant la composition des lignes de cuivre de l'endpoint.

Nom du champ	Type	Description
diameter	float	Diamètre (en millimètres) du fil de cuivre
length	float	Longeur (en mètres) du fil de cuivre

Exemple d'endpoint cuivre

{
     "endpoint_ref": "0140500044",
     "endpoint_ref_type": "line_number",
     "copper_info": {
         "status": "active",
         "unlisted_number": false,
         "available_pairs": 24,
         "max_available_pairs": 112,
         "under_construction": false,
         "nra": "75116AUT",
         "sections_lengths": [
            {
               "diameter": 5.0,
               "length": 100.0
            },
            {
               "diameter": 4.0,
               "length": 1280.0
            }
         ],
         "concentration_point": {
            "latlng":
                {
                    "latitude": 48.8521481,
                    "longitude": 2.2795104
                },
            "address": {
                "kosc_street_code": "7511678010",
                "kosc_insee_code": "75116",
                "street_number": "116",
                "street_name": "AVENUE DU PRESIDENT KENNEDY",
                "city": "PARIS 16"
            }
         }
     },
     "address": {
         "kosc_street_code": "7511678010",
         "kosc_insee_code": "75116",
         "street_number": "116",
         "street_name": "AVENUE DU PRESIDENT KENNEDY",
         "city": "PARIS 16",
         "housing_complex": "CAR REGIE",
         "owner_name": "JFD 2018"
     }
 }

Champ fiber_info

Nom du champ	Type	Description
building	dict	Le building fibre de l'otp
nro	string	NRO de l'otp

Exemple d'endpoint fibre

{
   "endpoint_ref": "FI-3790-3415",
   "endpoint_ref_type": "otp",
   "address": {
      "kosc_street_code": "9307700800",
      "kosc_insee_code": "93077",
      "street_number": "78",
      "street_name": "BOULEVARD D AULNAY",
      "city": "VILLEMOMBLE",
      "stairs": "6",
      "floor": "0",
      "building": "6"
   }
   "fiber_info": {
      "building": {
         "operator_code": "FI",
         "operator_name": "ORANGE",
         "name": "6",
         "building_ref": "IMB/93077/X/00NA",
         "type": "BUILDING",
         "nro": "93064RNY"
      }
   }
}