Endpoints

List the copper endpoints of an address

To search for a copper endpoint by address, you can list the endpoints by doing a GET on the url /api/v2/eligibility/endpoints/.

Parameters

Name of the parameter	Presence	Type	Constraint	Description
kosc_street_code	Mandatory	string	Max 11 chars	Kosc Street ID (to retrieve here)
street_number	Mandatory	string	Max 7 chars	Street Number (to verify here)
status	Optional	string	(active, inactive)	endpoint status filter

Response

The API will return a list of copper endpoints (documentation of the endpoint here).

Example

GET /api/v2/eligibility/endpoints/?street_number=6&kosc_street_code=7511412420 HTTP/1.1
Host: extranet.kosc-telecom.fr

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

[
    {
        "endpoint_ref": "0145407618",
        "endpoint_ref_type": "line_number",
        "address": {
            "kosc_street_code": "7511412420",
            "kosc_insee_code": "75114",
            "street_number": "6",
            "street_name": "RUE BOYER BARRET",
            "city": "PARIS 14",
            "housing_complex": "S",
            "floor": "00",
            "owner_name": "FEDER ORGANISME SOINS DOMICILE PARI0000"
        },
        "copper_info": {
            "status": "active",
            "unlisted_number": false,
            "concentration_point": {
                "latlng": {
                    "latitude": 48.832999,
                    "longitude": 2.3174737
                },
                "address": {
                    "kosc_street_code": "7511412420",
                    "kosc_insee_code": "75114",
                    "street_number": "6",
                    "street_name": "RUE BOYER BARRET",
                    "city": "PARIS 14"
                }
            }
        }
    },
    {
        "endpoint_ref": "0144197944",
        "endpoint_ref_type": "line_number",
        "address": {
            "kosc_street_code": "7511412420",
            "kosc_insee_code": "75114",
            "street_number": "6",
            "street_name": "RUE BOYER BARRET",
            "city": "PARIS 14",
            "floor": "00",
            "door": "0COUR",
            "owner_name": "GIRAUDY MAXIME"
        },
        "copper_info": {
            "status": "active",
            "unlisted_number": true,
            "concentration_point": {
                "latlng": {
                    "latitude": 48.832999,
                    "longitude": 2.3174737
                },
                "address": {
                    "kosc_street_code": "7511412420",
                    "kosc_insee_code": "75114",
                    "street_number": "6",
                    "street_name": "RUE BOYER BARRET",
                    "city": "PARIS 14"
                }
            }
        }
    }
 ]

Errors

HTTP code	Message
400	Invalid input
500	Unable to serve your request
504	External web service unreachable

Getting information from an endpoint

Making a GET call on the /api/v2/eligibility/endpoints/{endpoint_ref}/ url allows you to obtain more detailed information about a known endpoint.

Parameters

Name of the parameter	Presence	Type	Constraint	Description
endpoint_ref_type	Mandatory	string	(line_number, otp)	endpoint type

Getting information from an endpoint line_number (copper)

Parameters specific to enpoint line_number

Name of the parameter	Presence	Type	Constraint	Description
activation_type	Mandatory	string	(activate, create, create_neighbour, create_nearby)	Activation type
status	Optional	string	(active, inactive)	endpoint status

Note

Depending on the type of activation chosen, the fields available_pairs and max_available_pairs are likely to change.

Note

If the parameter inactive is not provided, there will be a check on an active endpoint and then on an inactive endpoint, if none of them is found an error will be returned.

Note

The fields kosc_insee_code and kosc_street_code can be set to null in case they cannot be evaluated due to lack of data.

Response

The API will return a copper endpoint (documentation of the endpoint here).

Example

GET /api/v2/eligibility/endpoints/0145407618/?endpoint_ref_type=line_number&activation_type=activate HTTP/1.1
Host: extranet.kosc-telecom.fr

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

{
    "endpoint_ref": "0145407618",
    "endpoint_ref_type": "line_number",
    "address": {
        "kosc_street_code": "7511412420",
        "kosc_insee_code": "75114",
        "street_number": "6",
        "street_name": "RUE BOYER BARRET",
        "city": "PARIS 14",
        "housing_complex": "S",
        "floor": "00",
        "owner_name": "FEDER ORGANISME SOINS DOMICILE PARI0000"
    },
    "copper_info": {
        "status": "active",
        "unlisted_number": false,
        "available_pairs": 3,
        "max_available_pairs": 6,
        "under_construction": false,
        "sections_lengths": [
            {
                "diameter": 4,
                "length": 2206
            }
        ],
        "concentration_point": {
            "latlng": {
                "latitude": 48.832999,
                "longitude": 2.3174737
            },
            "address": {
                "kosc_street_code": "7511412420",
                "kosc_insee_code": "75114",
                "street_number": "6",
                "street_name": "RUE BOYER BARRET",
                "city": "PARIS 14"
            }
        }
    }
}

Getting information from an endpoint otp (fiber)

Response

The API returns a fiber endpoint (documentation of the endpoint here).

Example

GET /api/v2/eligibility/endpoints/FI-3790-3415/?endpoint_ref_type=otp HTTP/1.1
Host: extranet.kosc-telecom.fr

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

{
    "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"
    },
    "fiber_info": {
        "nro": "93064RNY",
        "building": {
            "operator_code": "FI",
            "operator_name": "ORANGE",
            "name": "6",
            "building_ref": "IMB/93077/X/00NA",
            "type": "BUILDING",
            "nro": "93064RNY",
            "address": {
                "street_number": "78",
                "street_name": "BOULEVARD D AULNAY",
                "kosc_street_code": "9307700800",
                "kosc_insee_code": "93077",
                "city": "VILLEMOMBLE"
            }
        }
    }
}

Errors

HTTP code	Message
400	Invalid input
404	Endpoint not found
500	Unable to serve your request
504	External web service unreachable