Endpoint

An endpoint is an object containing the information necessary to accurately identify the type of line and its unique reference.

Field Name	Type	Description
endpoint_ref_type	string	endpoint type (line_number, otp)
endpoint_ref	string	endpoint identifier
address	dict	endpoint address

Fields specific to copper endpoint

Field name	Type	Description
copper_info	dict	Technical information for copper

Fields specific to the fiber endpoint

Field name	Type	Description
fiber_info	dict	Technical information for fiber

Field address

Field name	Type	Description
kosc_street_code	string	Kosc street ID
kosc_insee_code	string	Kosc INSEE code identifying the city
street_number	string	Street Number
street_name	string	Street Name
city	string	City name
stairs	string	Stairs
floor	string	Floor
building	string	Building name

Address fields specific to the copper endpoint

Field name	Type	Description
housing_complex	string	Residence name
door	string	Door
owner_name	string	Owner name of the residence

Field copper_info

Field Name	Type	Description
status	string	endpoint status (active, inactive)
unlisted_number	boolean	Indicates if the phone number is unlisted
available_pairs	integer	Number of pairs available at the Connection Concentration Point (CP)
max_available_pairs	integer	Number of pairs available at the Concentration Point (CP) serving the address and having the most pairs available
under_construction	boolean	Indicates if the line is under construction
sections_lengths	dict list	List of copper lengths that build the line
nra	string	NRA code attached to the``endpoint``
concentration_point	dict	Informations about the concentration point

Field copper_info.concentration_point

Field Name	Type	Description
latlng	dict	Geographical coordinates of the concentration point
address	dict	Address of the concentration point

Field copper_info.concentration_point.latlng

Field Name	Type	Description
latitude	float	Latitude
longitude	float	Longitude

The field concentration_point.address has the same composition as the field address quoted above except for the field owner_name.

Field copper_info.concentration_point.address

Field Name	Type	Description
kosc_street_code	string	Kosc Street code
kosc_insee_code	string	Kosc INSEE code identifying the city
street_number	string	Street number
street_name	string	Street name
city	string	City name

Field copper_info.sections_lengths

The field copper_info.sections_lengths is a list of dictionaries representing the composition of the lines of copper of the endpoint.

Field Name	Type	Description
diameter	float	Diameter (in millimetres) of copper wire
length	float	Length (in meters) of copper wire

Example of copper endpoint

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

Field fiber_info

Field Name	Type	Description
building	dict	The fiber building of the otp
nro	string	NRO of otp

Example of fiber endpoint

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