Eligibility of different offers

Obtain an eligibility

Before placing an order, it is imperative to launch an eligibility via a POST on the url /api/v2/eligibility/offers/. An eligibility identifier is then returned by the API and must be provided during the creation of the order.

Parameters

Name of the parameter	Presence	Type	Constraint	Description
reference	Mandatory	string	see below	Reference of the endpoint or of building used for eligibility
reference_type	Mandatory	string	(building, line_number, otp)	Reference type
product_lines	Optional	string list	to see below	List of product line codes used for eligibility

Name of the parameter	Type of reference	Constraint
reference	line_number	10 chars number - 0478299251
reference	building	up to 32 chars - IMB/93077/X/00HE
reference	otp	12 chars - FI-3790-3415

Note

Only fiber product_lines will be considered for an endpoint otp or for a building. Only copper product_lines will be considered for an endpoint line_number. If product_lines are not passed as parameters, the list of product lines subscribed by the client will be used.

Parameters specific to the eligibility of a line_number

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

Note

The kosc_insee_code and kosc_street_code fields may be set to null if they cannot be evaluated due to lack of data.

Response

The API response is a dictionary containing an eligibility query identifier, the list of offers as well as as a summary on the endpoint.

Field name	Type	Description
offers	dict list	Eligibility response for each product of the selected product lines
eligibility_ref	string	Eligibility request ID (to be provided when placing an order)
endpoint	dict	the endpoint of the eligibility

Get eligibility on a line_number (copper) endpoint

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

Ineligibility and eligibility under copper conditions

List of possible codes rendering a copper offer ineligible

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

List of possible codes making a copper offer eligible under 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.

Getting eligibility on an endpoint otp (fiber)

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": "500.00",
            "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",
            "address": {
                "street_number": "78",
                "street_name": "BOULEVARD D AULNAY",
                "kosc_street_code": "9307700800",
                "kosc_insee_code": "93077",
                "city": "VILLEMOMBLE"
            }
        }
    }
}

Getting eligibility on building (fiber)

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": "1000.00",
            "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",
            "address": {
                "street_number": "14",
                "street_name": "AVENUE DES FRERES VERDEAUX",
                "kosc_street_code": "7710815602",
                "kosc_insee_code": "77108",
                "city": "CHELLES"
            }
        }
    }
}

Fiber ineligibility

The table below lists the possible codes that make a fiber offer ineligible:

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

Errors

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 of the offers field

The offers field is a dictionary list containing the eligibility results for each of the product lines you sent.

Field name	Type	Description
product	dict	Product Information
product_line	dict	Product line information
eligibility	dict	Eligibility information
setup_fee	string	Provision costs in euros, fiber only
order_delay	string	Delivery time in days, fiber only

Note

In the case where the setup_fee field is empty, please refer to the contracts.

Field offers[].product

The field offers[].product is a dictionary containing information about the product.

Field Name	Type	Description
code	string	Product Code
name	string	Product Name
provider	string	Service provider’s name
priority	string	Character string to order offers logically

Field offers[].product_line

The field offers[].product_line is a dictionary containing information about the product line.

Field Name	Type	Description
code	string	Product line code
name	string	Product line name

Field offers[].eligibility

The field offers[].eligibility is a dictionary containing eligibility information about the product.

Field name	Type	Description
eligible	boolean or null	Defined if the offer is eligible for the product. Can be null if the operator could not be contacted (the error will then be listed in the reasons field).
under_conditions	dict list or null	Contains the list of warnings to be taken into account when the offer is eligible.
reasons	dict list or null	Contains a list of reasons why the offer is not eligible.

Fields offers[].eligibility.reasons and offers[].eligibility.under_conditions

The fields offers[].eligibility.reasons and offers[].eligibility.under_conditions are lists of dictionaries in the following format:

Field Name	Type	Description
code	string	Technical code representing reason for ineligibility or eligibility condition
message	string	Reason for non-eligibility or text-based eligibility condition
availability_date	string	Date of availability of the offer (if the code of non eligibility is COPPER_NOT_YET_AVAILABLE, FIBER_NOT_YET_AVAILABLE or PRODUCT_NOT_YET_AVAILABLE)