Eligibilité des différentes offres

Obtenir une éligibilité

Avant d’effectuer une commande, il est impératif de lancer une éligibilité via un POST sur l’url /api/v2/eligibility/offers/. Un identifiant d’éligibilité est alors retourné par l’API et devra être fourni lors de la création du projet de commande.

Paramètres

Nom du paramètre	Présence	Type	Contrainte	Description
reference	Obligatoire	string	voir ci-dessous	Référence de l'endpoint ou du building utilisée pour l'éligibilité
reference_type	Obligatoire	string	(building, line_number, otp)	Type de la référence
product_lines	Optionnel	string list	à voir ci-dessous	Liste des codes des lignes de produits utilisée pour l'éligibilité

Nom du paramètre	Type de référence	Contrainte
reference	line_number	10 chars number - 0478299251
reference	building	jusqu'à 32 caractères - IMB/93077/X/00HE
reference	otp	12 chars - FI-3790-3415

Note

Seules les product_lines fibre seront prises en compte pour un endpoint otp ou pour un building. Seules les product_lines cuivre seront prises en compte pour un endpoint line_number. Si les product_lines ne sont pas passées en paramètre, la liste des lignes de produit souscrites par le client sera utilisée.

Paramètres spécifiques à l'éligibilité d'un line_number

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

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

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	dict list	Réponse d'éligibilité pour chaques produits des lignes de produit selectionnées
eligibility_ref	string	Identifiant de la requête d'éligibilité (à fournir lors du passage de la commande)
endpoint	dict	l'endpoint de l'éligibilité

Obtenir une éligibilité sur un endpoint line_number (cuivre)

POST /api/v2/eligibility/offers/  HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
    "reference": "0492002525",
    "reference_type": "line_number",
    "activation_type": "activate",
    "status": "active",
    "product_lines": ["AM"]
}

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

{
    "offers": [
        {
            "eligibility": {
                "under_conditions": [
                    {
                        "code": "COMPATIBILITY_CHECK",
                        "message": "The local loop compatibility has to be checked."
                    }
                ],
                "eligible": true,
                "reasons": null
            },
            "product_line": {
                "code": "AM",
                "name": "ADSL-Max"
            },
            "product": {
                "code": "AM08",
                "provider": "KOSC",
                "name": "ADSL-Max_shared_BE_KOSC",
                "priority": "000100010008",
                "options": {
                    "portability": {
                        "enabled": false
                    }
                }
            }
        },
        {
            "eligibility": {
                "under_conditions": null,
                "eligible": true,
                "reasons": null
            },
            "product_line": {
                "code": "AM",
                "name": "ADSL-Max"
            },
            "product": {
                "code": "AM01",
                "provider": "KOSC",
                "name": "ADSL-Max_FULL_BE_KOSC",
                "priority": "000100010001",
                "options": {
                    "portability": {
                        "enabled": true
                    }
                }
            }
        }
    ],
    "eligibility_ref": "elig-1872f35c-b03b-45df-b711-9ac624e2e4ed",
    "endpoint": {
        "endpoint_ref": "0492002525",
        "endpoint_ref_type": "line_number",
        "address": {
            "kosc_street_code": "0608859150",
            "kosc_insee_code": "06088",
            "street_number": "40",
            "street_name": "BOULEVARD SAINT ROCH",
            "city": "NICE",
            "owner_name": "NUMERIS ETS REMY"
        },
        "copper_info": {
            "status": "active",
            "unlisted_number": false,
            "available_pairs": 1,
            "max_available_pairs": 2,
            "under_construction": false,
            "sections_lengths": [
                {
                    "diameter": 4,
                    "length": 1517
                }
            ],
            "concentration_point": {
                "latlng": {
                    "latitude": 43.7117745,
                    "longitude": 7.2930902
                },
                "address": {
                    "kosc_street_code": "0608859150",
                    "kosc_insee_code": "06088",
                    "street_number": "40",
                    "street_name": "BOULEVARD SAINT ROCH",
                    "city": "NICE"
                }
            }
        }
    }
}

Inéligibilité et éligibilité sous conditions cuivre

Liste les codes possibles rendant une offre cuivre non éligible

Code	Message	Eligible
COPPER_NOT_AVAILABLE	Copper not available in this area.	false
COPPER_NOT_YET_AVAILABLE	Copper not currently available in this area.	false
PRODUCT_NOT_YET_AVAILABLE	Product not yet available.	false
TOO_MUCH_ATTENUATION	Too much attenuation to deliver the product.	false
NETWORK_SATURATED	Network saturated, product cannot be delivered.	false
INCOMPATIBLE_LOCAL_LOOP	Incompatible local loop.	false
EXTERNAL_WS_UNREACHABLE	External web service unreachable, try later.	null

Liste les codes possibles rendant une offre cuivre éligible sous conditions

Code	Message
PAIRS_SATURATION	Not enough pairs to deliver the product in state.
ATTENUATION_LIMIT	Attenuation is close to the limit value.
COMPATIBILITY_CHECK	The line compatibility has to be checked.
DELAY_30	A 30-day delay is probably required.
DELAY_7	Delivery date may be more than 7 days.

Obtenir une éligibilité sur un endpoint otp (fibre)

POST /api/v2/eligibility/offers/  HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
    "reference": "FI-3790-3415",
    "reference_type": "otp",
    "product_lines": ["FP"]
}

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

{
    "offers": [
        {
            "eligibility": {
                "under_conditions": null,
                "eligible": false,
                "reasons": [
                    {
                        "code": "FIBER_NOT_YET_AVAILABLE",
                        "message": "Fiber not currently available in this area.",
                        "availability_date": "2018-07-15"
                    }
                ]
            },
            "product_line": {
                "code": "FP",
                "name": "PRO-FIBER"
            },
            "product": {
                "code": "FP01",
                "provider": "",
                "name": "PROFESSIONAL-FIBER",
                "priority": "001000600001",
                "options": null
            },
            "setup_fee": "",
            "order_delay": "60"
        }
    ],
    "eligibility_ref": "elig-0baa9208-9455-4148-93e7-56a6fab97045",
    "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"
        },
        "copper_info": {
            "status": null
        }
    },
    "fiber_info": {
        "building": {
            "operator_code": "FI",
            "operator_name": "ORANGE",
            "name": "6",
            "building_ref": "IMB/93077/X/00NA",
            "type": "BUILDING",
            "nro": "93064RNY",
            "reference_pm": "FI-93077-001G",
            "address": {
                "street_number": "78",
                "street_name": "BOULEVARD D AULNAY",
                "kosc_street_code": "9307700800",
                "kosc_insee_code": "93077",
                "city": "VILLEMOMBLE"
            }
        }
    }
}

Obtenir une éligibilité sur un building (fibre)

POST /api/v2/eligibility/offers/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
    "reference": "IMB/77108/X/031C",
    "reference_type": "building",
    "product_lines": ["FP"]
}

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

{
    "offers": [
        {
            "eligibility": {
                "under_conditions": null,
                "eligible": true,
                "reasons": null
            },
            "product_line": {
                "code": "FP",
                "name": "PRO-FIBER"
            },
            "product": {
                "code": "FP01",
                "provider": "",
                "name": "PROFESSIONAL-FIBER",
                "priority": "001000600001",
                "options": null
            },
            "setup_fee": "",
            "order_delay": "60"
        }
    ],
    "eligibility_ref": "elig-13142c1a-583d-4ebe-9d3b-a1b9ed75681d",
    "endpoint": {
        "address": {
            "kosc_street_code": "7710815602",
            "kosc_insee_code": "77108",
            "street_number": "14",
            "street_name": "AVENUE DES FRERES VERDEAUX",
            "city": "CHELLES"
        },
    },
    "fiber_info": {
        "building": {
            "operator_code": "FI",
            "operator_name": "ORANGE",
            "name": "",
            "building_ref": "IMB/77108/X/031C",
            "type": "HOUSE",
            "nro": "77108CHE",
            "reference_pm: "FI-77108-000K",
            "address": {
                "street_number": "14",
                "street_name": "AVENUE DES FRERES VERDEAUX",
                "kosc_street_code": "7710815602",
                "kosc_insee_code": "77108",
                "city": "CHELLES"
            }
        }
    }
}

Inéligibilité fibre

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

Code	Message	Eligible
FIBER_NOT_AVAILABLE	Fiber not available in this area.	false
PRODUCT_NOT_AVAILABLE	Product not available in this area.	false
FIBER_NOT_YET_AVAILABLE	Fiber not currently available in this area.	false
FIBER_NOT_DEPLOYED_IN_BUILDING	Fiber not deployed in this building.	false
FIBER_NOT_YET_DEPLOYED	Fiber not currently deployed in this area.	false
OTP_NOT_CONNECTABLE	Otp is not connectable.	false
OTP_NOT_MARKETABLE	Otp is not marketable.	false
UNCERTAIN_DATA	Uncertain data from infrastructure operator.	null

Erreurs

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

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	dict	Informations sur le produit
product_line	dict	Informations sur la ligne de produits
eligibility	dict	Information d'éligibilité
setup_fee	string	Chaine vide, fibre uniquement
order_delay	string	Délai de mise à disposition en jours, fibre uniquement

Note

Nouveauté en version 2.1 : Le champ setup_fee n'est plus renseigné. Veuillez vous référer à vos conditions contractuelles.

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 or null	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	dict list or null	Contient la liste des avertissements à prendre en compte lorsque l'offer est éligible.
reasons	dict list or null	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 dictionnaires au format suivant:

Nom du champ	Type	Description
code	string	Code technique représentant la raison de la non éligibilité ou la condition d'éligibilité
message	string	Raison de la non éligibilité ou de la condition d'éligibilité sous forme de texte
availability_date	string	Date de disponibilité de l'offre (si le code de non éligibilité est COPPER_NOT_YET_AVAILABLE, FIBER_NOT_YET_AVAILABLE ou PRODUCT_NOT_YET_AVAILABLE)