Eligibilité des différentes offres

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.

Obtenir une éligibilité cuivre à partir d'un endpoint

Avant d’effectuer une commande sur un endpoint cuivre, il est impératif de lancer une éligibilité en faisant un GET sur l’url /api/eligibility/endpoints/{endpoint_ref}/offers/. Un identifiant d’éligibilité est alors retourné par l’API et devra être fourni lors de la commande effective.

Paramètres

La totalité des paramètres suivants doivent être fournis en query_param.

Nom du paramètre

Description

inactive

Statut de l'endpoint

activation_type

Type d'activation (activate, create, create_neighbour ou create_nearby)

endpoint_ref_type

Type de l'endpoint (line_number)

product_line

Code de la ligne de produits sur laquelle faire l'éligibilité

Note

Plusieurs lignes de produits peuvent être testées en passant plusieurs fois le paramètre product_line. Seulement les produits cuivre seront acceptés.

Réponse

La réponse de l'API est un dictionnaire contenant un identifiant de requête d'éligibilité, la liste des offres ainsi qu'un récapitulatif sur l'endpoint.

Nom du champ

Type

Description

offers

liste de dictionnaires

Réponse d'éligibilité pour chaques produits des lignes de produit selectionnées. Documentation

eligibility_ref

string

Identifiant de la requête d'éligibilité, à fournir lors du passage de la commande

endpoint

dictionnaire

Endpoint utilisé pour l'éligibilité. Documentation

Exemple

GET /api/eligibility/endpoints/0142305090/offers/?inactive=false&activation_type=activate&endpoint_ref_type=line_number&product_line=SB HTTP/1.1
Host: extranet.kosc-telecom.fr
HTTP/1.1 200 OK
Content-Type: application/json

{
    "offers": [
        {
            "eligibility": {
                "under_conditions": null,
                "eligible": true,
                "reasons": null
            },
            "product_line": {
                "code": "SB",
                "name": "SDSL-2M"
            },
            "product": {
                "code": "SB01",
                "provider": "KOSC",
                "name": "SDSL-2M_PREMIUM_C_1P_KOSC",
                "priority": "000300040001",
                "options": {
                    "portability": {
                        "enabled": true
                    }
                }
            }
        },
        {
            "eligibility": {
                "under_conditions": null,
                "eligible": true,
                "reasons": null
            },
            "product_line": {
                "code": "SB",
                "name": "SDSL-2M"
            },
            "product": {
                "code": "SB13",
                "provider": "KOSC",
                "name": "SDSL-2M_standard_p_1P_KOSC",
                "priority": "000300040013",
                "options": {
                    "portability": {
                        "enabled": true
                    }
                }
            }
        }
    ],
    "eligibility_ref": "elig-a3947104-2f50-408a-a797-46eb440150c6",
    "endpoint": {
        "endpoint_ref": "0142305090",
        "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": 24,
            "max_available_pairs": 112,
            "under_construction": false
        },
        "characteristics": {
            "sections_lengths": [
                {
                    "diameter": 5.0,
                    "length": 100.0
                },
                {
                    "diameter": 4.0,
                    "length": 1280.0
                }
            ],
            "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"
        }
    }
}

Inéligibilité et éligibilité sous conditions

Le tableau ci dessous liste les codes possibles rendant une offre non éligible:

Code d'erreur

Description

PTFID_NOT_YET_AVAILABLE

Le Ptfid n'est pas encore disponible

KOSC_NOT_IN_NRA

Kosc n'est pas encore présent dans ce NRA

INSUFFICIENT_FLOW_RATE

Il y a trop d'atténuation pour livrer le produit

NRA_NOT_YET_AVAILABLE

Le NRA n'est pas encore disponible, le champ availability_date est retourné

PRODUCT_NOT_YET_AVAILABLE

Le produit n'est pas encore disponible, le champ availability_date est retourné

PROVIDER_UNREACHABLE

Le fournisseur de services n'est pas disponible

M3001

Le service demandé n'est pas disponible sur la ligne

M3003

L'atténuation est trop élevée pour fournie le service demandé

M3004

Problème de commutation des ressources

M3007

Un équipement actif est présent sur la ligne

M3008

La ligne fournie est utilisée

M3021

L'atténuation de la ligne autorise une offre standard

M3024

Ligne simple analogique

M3025

Groupement analogique

M3026

Accès de base (T0) isolé

M3027

Groupement d'accès de base (T0)

M3028

Accès primaire (T2) isolé

M3029

Groupement d'accès primaires (T2)

M3031

Ligne de support non disponible

M3032

En dehors du du cadre autorisé

M3033

Service saturé

M3046

Le numéro n'est pas attribué à l'opérateur de boucle locale

Le tableau ci dessous liste les codes possibles rendant une offre éligible sous conditions:

Code d'erreur

Description

REASON_SATURATION:

Pas assez de paires pour livrer le produit

M2002

L'atténuation est proche de la valeur limite

M2004

L'opérateur de boucle locale a besoin de vérifier la compatibilité de la ligne avec le service demandé

M2005

L'opérateur de boucle locale a besoin de vérifier la compatibilité de la ligne avec le service demandé

M2010

Aucune paire disponible à l'adresse indiquée

M2012

Ligne "Numéris accès de base"

M2013

Ligne aisant partie d'un "groupement de lignes analogiques"

M2014

Ligne aisant partie d'un "groupement d'accès de base"

M2015

Ligne aisant partie d'un "groupement d'accès primaires"

M2016

Ligne de type "Numéris accès primaire"

M2017

Un délai de 30-day sera probablement requis

M2018

Une action pouvant modifier l'éligibilité de la ligne est en cours

M2019

La delais de livraison peut être supérieur à 7 jours

M2020

Le service demandé est incompatible avec les services du client final

M2022

Le nombre de paires n'est pas suffisant pour livrer service demandé

M2024

Zone dépourvue de cuivre

M2050

Pas de boucle locale valide sur le point de concentration pour évaluer l'éligibilité

Gestion des erreurs

Documentation ici

Description du champ offers

Le champ offers est une liste de dictionnaires contenant les résultats d'éligibilité pour les produits de chacune des lignes de produits que vous avez envoyées.

Nom du champ

Type

Description

product

dictionnaire

Informations sur le produit

product_line

dictionnaire

Informations sur la ligne de produits

eligibility

dictionnaire

Information d'éligibilité

Champ offers[].product

Le champ offers[].product est un dictionnaire contenant les informations sur le produit.

Nom du champ

Type

Description

code

string

Code du produit

name

string

Nom du produit

provider

string

Nom du fournisseur de service

priority

string

Chaine de caractère permettant d'ordonner les offres de façon logique

Champ offers[].product_line

Le champ offers[].product_line est un dictionnaire contenant les informations sur la ligne de produit.

Nom du champ

Type

Description

code

string

Code de la ligne de produits

name

string

Nom de la ligne de produits

Champ offers[].eligibility

Le champ offers[].eligibility est un dictionnaire contenant les informations d'éligibilité sur le produit.

Nom du champ

Type

Description

eligible

boolean

Défini si l'offer est éligible pour le produit. Peut être null si l'opérateur n'a pas pu être contacté (l'erreur sera alors listée dans le champ reasons).

under_conditions

liste de dictionnaires

Contient la liste des avertissements à prendre en compte lorsque l'offer est éligible.

reasons

liste de dictionnaires

Contient la liste des raisons pour lesquelles l'offer n'est pas éligible.

Champs offers[].eligibility.reasons et offers[].eligibility.under_conditions

Les champs offers[].eligibility.reasons et offers[].eligibility.under_conditions sont des listes de dictionnaire de la forme suivante:

Nom du champ

Type

Description

code

string

Code technique représentant la raison de la non éligibilité

message

string

Raison de la non éligibilité sous forme de texte

availability_date

string

Date de disponibilité de l'offre, si le code de non éligibilité est NRA_NOT_YET_AVAILABLE ou PRODUCT_NOT_YET_AVAILABLE