Endpoints

Lister les endpoints cuivre d'une adresse

Pour rechercher un endpoint cuivre par adresse, vous pouvez lister les endpoints en faisant un GET sur l'url /api/v2/eligibility/endpoints/.

Paramètres

Nom du paramètre	Présence	Type	Contrainte	Description
kosc_street_code	Obligatoire	string	Max 11 chars	Code de rue Kosc (à récupérer ici)
street_number	Obligatoire	string	Max 7 chars	Numéro de rue (à vérifier ici)
status	Optionnel	string	(active, inactive)	Filtre sur le statut de l'endpoint

Réponse

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

Exemple

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

Erreurs

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

Obtenir les informations d'un endpoint

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

Paramètres

Nom du paramètre	Présence	Type	Contrainte	Description
endpoint_ref_type	Obligatoire	string	(line_number, otp)	Le type de l'endpoint

Obtenir les informations d'un endpoint line_number (cuivre)

Paramètres spécifiques à l'enpoint line_number

Nom du paramètre	Présence	Type	Contrainte	Description
activation_type	Obligatoire	string	(activate, create, create_neighbour, create_nearby)	Type d'activation
status	Optionnel	string	(active, inactive)	Statut de l'endpoint

Note

Suivant le type d'activation choisi, les champs available_pairs et max_available_pairs sont susceptibles de changer.

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.

Note

Les champs kosc_insee_code et kosc_street_code peuvent être à null dans le cas où ne pouvons pas les évaluer dû à un manque de données.

Réponse

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

Exemple

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

Obtenir les informations d'un endpoint otp (fibre)

Réponse

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

Exemple

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

Erreurs

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