Getting started

• [Introduction](#introduction
  • Release content (11/06/2024)
  • Release content (09/12/2024)
  • Release content (06/19/2024)
  • Release content (02/20/2024)
  • Release content (01/16/2024)
  • Release content (11/29/2023)
  • Release content (10/24/2023)
  • Release content (09/12/2023)
  • Release content (07/11/2023)
  • Release content (04/12/2023)
  • Release content (02/22/2023)
  • Release content (01/03/2023)
  • Release content (11/24/2022)
  • Release content (09/28/2022)
  • Release content (08/24/2022)
  • Release content (06/30/2022)
  • Release content (05/24/2022)
  • Release content (04/07/2022)
  • Release content (03/07/2022)
  • Release content (01/24/2022)
  • Release content (11/02/2021)
  • Security
  • How to authenticate
  • End Point
  • Methods and URL
  • Example of request with headers and body
  • Glossary
• Service description
  • Ressources and entry parameters
  • Output parameters
  • FTTE offers characteristics
  • FTTH offers characteristics
  • FTTO offers characteristics
  • Copper for Company or General Public or Wholesale offers characteristics
  • Portability tests characteristics
  • Use case examples for FTTE eligibility tests
  • Use case examples for FTTH eligibility tests
  • Use case examples for FTTO eligibility tests
  • Use case examples for Copper for Company eligibility tests
    • Eligibility of an active ND
    • Eligibility of a prestation number
    • Eligibility in housing area new buildings (ZLIN)
  • Use case examples for Copper for General Public eligibility tests
    • Use case example for Company Copper with multiple ND, precable numbers and prestation numbers
  • Example of use cases with a SETIAR contract
    • Eligibility of an address on the street number
    • Eligibility of an address with restitution of other street numbers
    • Eligibility of a neighbouring address
    • Eligibility of an address by targeting an address element
    • Search for PC
  • Use case examples for Wholesale eligibility tests
    • Eligibility from textual address
  • Use case example of eligibility test in 1 call for Copper and Wholesale offers
  • Use case examples for portability tests
    • VG portability test with operator removal and retention
• Support for the migration of webservices to the Operator Eligibility API
• Appendix
  • Download list of Errors and HTTP codes
  • History of document

Introduction

This API allows to check the elibibility to FTTE, FTTH, FTTO, company or public copper offers, Wholesale and portability for a given site. Tests can be conducted on the basis of :

• ND active or inactive
• Precable number
• Prestation number
• Standard address
• Geographical coordinates (GPS format WGS84)
• Textual address
• Building code

This API allows to check the eligibility for the portability of an ND active.
It is requested to sign a contract with the marketing department of Orange Wholesale to access this service.

Release content 11/06/2024

Change of the HTTP error codes

Added error code 9034 for invalid NDs :See the document in the appendix.

Release content 09/12/2024

GPON and XGSPON eligibility calculation and restoration: 8G/8G speeds added

-Restore new characteristic for the FTTH Access offer in the case of positive eligibility; this characteristics indicate the availability or non-availability of the speed 8G/8G.
PS :This feature will be deactivated in this release, and the activation date is 10/10/2024

AERO rewiring on IO source data for BLOM FTEL :

for :

• FTTH Access
• Just fibre

If an OI block exists ( Eligibility block in IPE files ) then the following information will be returned:

• qualificationItemResult= notEligible

• qualificationItemReason = blocked

• blockingType = OIORANGE

• blockingReason = blocking reason in IPE

If an OC blocking exists ( Eligibility blocking in RECIF ) then the following information will be returned:

• blockingType =OCORANGE

Translated with DeepL.com (free version)

Release content 06/19/2024

Evolution of Optical Zoning for FTTO

An evolution of common optical zoning is planned as part of the optical access of Core Ethernet Enterprises (C2E) and Core Ethernet LAN (CELAN) offers. The optical zoning file and eligibility thresholds will be updated for CELAN and C2E offers as described in the table below:

• 200M
• 300M_1G to 300M-1G
• 2G_4G to 2G-4G

Release content 02/20/2024

Copper Commercial Closure : Addition of forecast dates for the FCC and FCT milestones

Displaying the following information in the API response of all copper offerings:

• dateDuJalonFCT: the value of this characteristic contains the forecast date of the technical closure of copper
• dateDuJalonFCC: the value of this characteristic contains the forecast date of the commercial closure of copper

Management of copper closure at the neighborhood mesh (Addition of the IRIS code)

For large municipalities, it is necessary to close gradually by neighborhood (district). This quarter mesh closure is identified by the IRIS code. When the IRIS code is not identified, the following information is displayed in the API:

• Code_Iris_Introuvable

Release content 01/16/2024

GPON and XGSPON eligibility calculation and restoration: 4G/8G speeds added

-Restore new characteristic for the FTTH Access offer in the case of positive eligibility; this characteristics indicate the availability or non-availability of the speed 4G/8G.
PS :This feature will be deactivated in this release, and the activation date is 02/13/2024

Release content 11/29/2023

GPON and XGSPON eligibility calculation and restoration: 400K/400K low bit rates removed

-Remove the 400K/400K characteristic for low data rates

Release content 10/24/2023

Calculation and restitution of GPON and XGSPON eligibility

-Restore new characteristics for the FTTH Access offer in the case of positive eligibility; these characteristics indicate the availability or non-availability of GPON and XGSPON speeds.
PS :This feature will be deactivated in this release, and the activation date will be announced shortly.

Restitution of regional technical plate data/exceptional connections

-Restore the correct Ethernet plate code/label values for exceptional connections.
Download the list of regional codes/labels displayed in AERO for the Ethernet plate

Release content 09/12/2023

Harmonize the API response between FTTE and FTTH

-Keep the FTTH structure, duplicate it on the FTTE offer, i.e. add "oiName" and "oiCode" for activated FTTE offers (for positive and negative eligibility). -Keep "blom" for activated FTTE offers (for positive eligibility). -Add "blom" for activated FTTE offers (for negative eligibility)

Restitution of "2G and 4G" throughput information

-Return "CELAN 2G and 4G with or without EAS" offer information

Release content 07/11/2023

Eligibility of the Optimum PM offer in ZTD HD zones

-Differentiate between Optimum PM and Optimum Access:
The ZTD HD zone (Very Dense High Density zones) is defined by : arcep zone = 1 and IRIS zone = 'HD'.
If zone is ZTD HD , than the adresse is eligible only for Optimum PM offer .

Update of eligibility conditions for Optimum Access/PM and Optimum Ethernet offers on Orange BLOM

-If an address exists in the IPE 3.1 files and the following conditions are not met:
BuildingStatus = DEPLOYED
BlockingType = {Empty} (No block on eligibility)
then the address is not eligible for FTTE offers.

Addition of the "Accès Essentiel" offer to the scope of FCA offers

Release content 04/12/2023

Optimum Ethernet extension on RIP Other than ORANGE's RIP

-Calculate the eligibility status for Optimum Ethernet offers for addresses covered by RIPs of BLOM: Altitude Infra, Axione, XP Fibre/SFR and TDF based on data from IPE 3.1.

-Eligibility levels must be displayed in AERO depending on whether a given RIP is in the pilot phase, open for marketing or unavailable (neither in the pilot nor open phase).

-Add new eligibility statuses according to following conditions as described in the following table ::

Optimum Ethernet extension on VENU

-From 05/02 to 05/15 , all the addresses of VENU will be ineligible for Optimum Ethernet offers:

In the API response for active FTTE offers

qualificationItemResult = not eligible
AND qualificationItemReason =commercialGel

From 05/15, Optimum Ethernet eligibility on the VENU RIP will be calculated based on the IPEs provided by Achill.

Make the FTTE syndic condition available only on the Orange BLOM

-Only buildings in the Orange BLOM Comply with the rules of the syndic condition

Restitution of the correct interop code

In the case of FTTH positive eligibility, we will change the value 'oiCode' in the API response : For the operator 'Orange', we return 'FTEL' instead of 'FT' For the operator 'DEBITEX', we return 'DEBI' instead of 'DEBITEX' For the operator 'Opalys', we return 'OPAL' instead of 'OPALYS' For the operator 'Réunicable SAS', we return 'REUN' instead of 'INTB'

Release content 02/22/2023

Copper Commercial Closure - batch 3

In this batch 3, we will:

1- return the FCC and FCT milestones for the following status : -error

• notFound

2- no longer return the FCA milestone when the address is commercially closed to copper (when you have the FCC or FCT milestone).

Restitution of data from the regional commercial plate in case of positive eligibility of an address for the following copper offers:

• DSL ACCESS
• DSL ACCESS ONLY
• Essential ACCESS
• DSL TV access
• DSL Access only TV

The newly returned data is as follows:

• collectionTrafficRegionCode: the Ethernet region code
• collectionTrafficRegionLabel: the Ethernet region label

Addition of "DSL Access Only TV" and "DSL Access TV" offers in the scope of FCA offers for the operator Bouygues

Add the message 'FCA' in 'product\characteristics\message' for the two offers "DSL Access Only TV" and "DSL Access TV" for the operator Bouygues only.

Insertion of the correct interop code for the SFR and Numericâble operators

In the case of positive FTTH eligibility, we will change the 'oiCode' value in the API response :

• For the 'SFR' operator, 'SFRA' is returned instead of 'SFR'.
• For the 'Numericâble' operator, 'NUME' is returned instead of 'NUMERI'.

Release content 01/03/2023

Opening of the FTTH ACCESS offer on the DROMs

• Integrate into AERO the "FTTH DROM Repository" which displays the information if the department or the municipality are opened or not to the offer "FTTH ACCES".
• Make DROM addresses eligible for the FTTH ACCESS offer if the offer is opened for the department and the municipality , if not the eligibility result is :

"qualificationItemResult": "notEligible",

"qualificationItemReason": "notAvailableCommune"

Return the information about the supply and delivery of ONT on the DROMs :

• In the API response, if a DROM address is eligible for the FTTH ACCES. Then, we will have the following new characteristics :

"name": "deliveryOntFT",

"value": "YES" or "NO"

"name": " deliveryInertfaceFibre",

"value": "YES" or "NO"

Release content 11/24/2022

Fixed incomplete display of buildings for a multi-building address for FTTH offers:

• Ruturn all the buildings related to a multi-building address for FTTH offers

Release content 09/28/2022

Removing of the buildingCode

• Remove the field "buildingCode" from the API response, at the geographicSite and geographicSubAddress .In API control , use the field buildingCodeOI instead of buildingCode

Disabling the FTTH ACCESS offer in the DROM

• Make the addresses of the DROM not eligible for FTTH Access on the date of October 12 (Date of activation of FTTH Access ) with "qualificationItemResult": "notEligible", "qualificationItemReason": "onlyMetropolitanAreaOffer" .

Fixed incomplete display of buildings for a multi-building address:

• Ruturn all the buildings related to a multi-building address

Fix of the RS information bug which did not appear for some addresses if "street_number" is "NULL".

Release content 08/24/2022

Town Copper Closure FCC :

• Display of the new 'FCG' or 'FCT' or 'FCC' value of the "message" characteristic in the API response.
• And concatenate it with any messages already present on the offer.
• qualificationItemResult: “notEligible”
• qualificationItemReason: No change

Release content 06/30/2022

Town Copper Closure FCC :

• Display of the new 'FCG' or 'FCT' or 'FCC' value of the "message" characteristic in the API response.
• And concatenate it with any messages already present on the offer.
• qualificationItemResult: “notEligible”
• qualificationItemReason: No change NB: This evolution will be postponed for a next production launch, the date of which will be communicated later

Purchase of the PREBLOM for the 2 RIPs Vienne and 2 Sèvres:

Make the addresses behind the PMs acquired by Orange eligible for the offres : Optimum Access, Optimum PM, Optimum Ethernet LAN and Optimum Ethernet Enterprises.

Release content 05/24/2022

Search by Building Code OI

Search by building code OI for all offers. We will remove all restrictions on the contextType buildingCode. On the other hand, we will only add the restriction on the size: The size of the buildingCode must not exceed 30 characters.

{
    "code": 9024,
    "message": "Invalid body field",
    "description": "publicKey.value must contains only 30 alphanumeric characters "
}

The search by buildingCode can be done with a buildingCodeOI or buildingCodeOC. Below is an example of an API request:

{  
   "contextType": "buildingCode",
   "category":
{       "name": "cue|ftte|ftth|ftto"    } 
,
   "publicKey":
{    "name" : "buildingCode",        
     "value": "ID-751200000171"     } 
}

Return the informations of the Ethernet Regional Plate for the FTTH offer (Just Fibre Test) in case of positive eligibility of an address :

• collectionTrafficRegionCode : Ethernet region code
• collectionTrafficRegionLabel : Ethernet region label

Release content 04/07/2022

Return the Syndic FTTE condition informations

For the offers :

• Optimum Access
• Optimum PM
• Optimum Ethernet
• Optimum Ethernet LAN
• Optimum Ethernet Entreprises

If a Syndic blockage exists then we will return the following informations :

• FTTE_passif_status = notEligible
• FTTE_passif_reason = blockedBySyndic
• FTTE_actif_status = notEligible
• FTTE_actif_reason = blockedBySyndic
• blockingType = contains blocking type

If No Agreement Syndic then we will return the following informations :

• FTTE_passif_status = notEligible
• FTTE_passif_reason = noAgreementSyndic
• FTTE_actif_status = notEligible
• FTTE_actif_reason = noAgreementSyndic
• blockingType = contains the status of the Syndic

Add the "productOffering" "FTTH Just Fibre Test" in the "productOfferingQualificationItem"

Release content 03/07/2022

Return the informations of the Ethernet Regional Plate for the FTTE offers (Optimum Ethernet LAN & Enterprises) and FTTO (Core Ethernet LAN & Enterprises) in case of positive eligibility of an address :

• collectionTrafficRegionCode : Ethernet region code
• collectionTrafficRegionLabel : Ethernet region label

Release content 01/24/2022

enrichment of building information ( the infrastructure and the commercial operator ), regardless of the blom: Orange or others.

New characteristics on FTTE and FTTH offers:

• buildingCodeOI: building code of the infrastructure operator.
• buildingCodeOC: building code of the commercial operator.

Notes:

• buildingCodeOI == buildingCodeOC if it is the Orange blom (Orange is OI and OC at the same time).
• To ensure service continuity for all operators, the buildingCode will be present in the API response for the next version. It will then be removed in a later version.
• For the search by buildingCode, use the building code of the commercial operator. A subsequent development will allow this research to be carried out using the building code of the infrastructure operator.

FTTO: Secure connections

Enrich the repository of secure connections with all the canceled services to give an idea of ​​the resources present at certain sites and their levels (RS1 / RS2 / or RS3).

Note: 1100 additional sites will be considered for eligibility.

Change of the HTTP error codes

See the document in the appendix.

Release content 11/02/2021

adding FTTH information on other BLOMs depending on commercial launching

New characteristics:

• oiName : Full Operator or RIP name. ex: Orange on BLOM Orange
• blomStatus: BLOM commercial status: underStudy, programmedLaunch, suspended, terminated, notCompatible, outdatedProtocol, notOpenYet
• launchingDate: Launching date in cas of a programmedLaunch

note: buildingCode will contain code OI

Correction: DSLAM characteristic on all copper offers

Security

Please read before client security measures, good practices for a secure integration of Orange APIs

How to authenticate

⚠ This API requires an OAuth 2.0 2-legged authentication. Please follow the method described here.

End Point

https://api.orange.com/operatoreligibility/v1

Methods and URL

Example of request with headers and body

curl -X POST -H "Authorization: Bearer i6m2iIcY0SodWSe...L3ojAXXrH" -H "Content-Type: application/json" -d '{ "contextType": "nd", "category": { "name": "ftte" }, "publicKey": { "name": "nd", "value": "0123456789" }}' https://api.orange.com/operatoreligibility/v1/productOfferingQualification

Glossary

Service description

Ressources and entry parameters

Output parameters

The characteristic's values depends on the offer. They are described in the following chapter.

FTTE offers characteristics

FTTH offers characteristics

FTTO offers characteristics

Copper for Company or General Public or Wholesale offers characteristics

Portability tests characteristics

| Characteristic's name | Format | Values | | --- | --- | --- | | cause | string | Portability result causes (ex. "OrangeMustCheckThePossibilityOfMaintainingThisNumber"). Download Portability causes list (FR)| | alert| string | Additionnal message (ex. "performIPtoPSTNportability"). Download Portability messages list (FR)| | arrivalAddress | string | Destination address | | redList | string | yes, no | | ndIsolated | string | yes, no | | recipientCodeName | string | ex "000001,FT RTCP" | | ndSupport | string (10 chiffres) | | | ndGeo | string | yes, no | | announcementAPNF | string | yes, no | | portaPossible | string | 1 : entrante, 2 : réentrante, 3 : entrante subséquente, 4 : sortante, 5 : subséquente | | recipientIndic | string | RESIL, ROUTAGE | | portabilityAPNF | string | yes, no | | protocolVoip | string | H323, SIP | | quarantineEndDate | date au format JJ/MM/AAAA | | | | | |

Portability error list

Download Portability description error list (FR)

Example of error response :

{
    "code": 61,
    "message": "Portability exception",
    "description": "152"
}

Use case examples for FTTE eligibility tests

Here are few use cases of the API

The ressource and method used are the same for all examples: Resource: /productOfferingQualification Méthode: POST

1. I want to check a site eligibility to Optimum offer (FTTE) from the following ND 01 23 45 67 89

{
  "contextType": "nd",
  "category": {
    "name": "ftte"
  },
  "publicKey": {
    "name": "nd",
    "value": "0123456789"
  }
}

I get :

{
    "code": 24,
    "message": "Invalid body field",
    "description": "The ND is not found."
}

2. I want to check a site eligibility to Optimum offer (FTTE) from a standardized address

{
  "contextType": "address",
  "category": {
    "name": "ftte"
  },
  "place": {
    "geographicAddress": {
      "streetNr": "1",
      "rivoliCode": "999F",
      "cityCode": "59221"
    }
  }
}

I get :

{
    "place": {
        "geographicSite": {
            "address": "1 RUE DU MONT HOUY, 59300 FAMARS",
            "normalizedAddress": {
                "inseeCode": "59221",
                "rivoliCode": "999F",
                "streetNr": "1",
                "streetNrSuffix": "",
                "streetType": "RUE",
                "streetName": "DU MONT HOUY",
                "postcode": "59300",
                "city": "FAMARS",
                "geographicSubAddress": [
                    {
                        "buildingCodeOC": "IMB/59221/X/00AR",
                        "buildingCodeOI": "IMB/59221/X/00AR",
                        "geographicLocation": {
                            "longitude": 3.5170222628171035,
                            "latitude": 50.31973667030669,
                            "accuracy": "building"
                        }
                    }
                ]
            }
        }
    },
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "Optimum Access",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "nroCode",
                        "value": "59480QUE"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "Optimum PM",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "pmCode",
                        "value": "FI-59221-000E"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "Optimum Ethernet",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "blom",
                        "value": "Orange"
                    },
                    {
                        "name": "oiCode",
                        "value": "FTEL"
                    },
                    {
                        "name": "oiName",
                        "value": "Orange"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "Optimum Ethernet LAN",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                   {
                        "name": "blom",
                        "value": "Orange"
                    },
                    {
                        "name": "oiCode",
                        "value": "FTEL"
                    },
                    {
                        "name": "oiName",
                        "value": "Orange"
                    },
                    {
                        "name": "collectionTrafficRegionCode",
                        "value": "NOR"
                    },
                    {
                        "name": "collectionTrafficRegionLabel",
                        "value": "Nord Pas de Calais"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "Optimum Ethernet Entreprises",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                   {
                        "name": "blom",
                        "value": "Orange"
                    },
                    {
                        "name": "oiCode",
                        "value": "FTEL"
                    },
                    {
                        "name": "oiName",
                        "value": "Orange"
                    },
                    {
                        "name": "collectionTrafficRegionCode",
                        "value": "NOR"
                    },
                    {
                        "name": "collectionTrafficRegionLabel",
                        "value": "Nord Pas de Calais"
                    }
                ]
            }
        }
    ],
    "address": "",
    "additionalParameters": {
        "contract": "setiar"
    }
}

3. I want to check a site eligibility to Optimum offer (FTTE) from a building by setting a standardized address which has multiple buildings

{
	"contextType": "address",
	"category": {
		"name": "ftte"
	},
	"place": {
		"geographicAddress": {
			"streetNr": "0",
			"rivoliCode": "691W",
			"cityCode": "69072",
			"geographicSubAddress": {
                "buildingCode": "IMB/69072/X/023D"
			}
		}
	}
}

I get :

{
    "place": {
        "geographicSite": {
            "address": "AVENUE DE LA PORTE DE LYON, 69570 DARDILLY",
            "normalizedAddress": {
                "inseeCode": "69072",
                "rivoliCode": "691W",
                "streetNr": "0",
                "streetNrSuffix": "",
                "streetType": "AVENUE",
                "streetName": "DE LA PORTE DE LYON",
                "postcode": "69570",
                "city": "DARDILLY",
                "geographicSubAddress": [
                    {
                        "buildingName": "HYPERMARCHE AUCHAN",
                        "buildingCodeOC": "IMB/69072/X/023D",
                        "buildingCodeOI": "IMB/69072/X/023D",
                        "geographicLocation": {
                            "longitude": 4.767430028359568,
                            "latitude": 45.81932713003021,
                            "accuracy": "building"
                        }
                    }
                ]
            }
        }
    },
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "Optimum Access",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "nroCode",
                        "value": "69040CAP"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "Optimum PM",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "pmCode",
                        "value": "FI-69072-0005"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "Optimum Ethernet",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                  {
                        "name": "blom",
                        "value": "Orange"
                    },
                    {
                        "name": "oiCode",
                        "value": "FTEL"
                    },
                    {
                        "name": "oiName",
                        "value": "Orange"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "Optimum Ethernet LAN",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                   {
                        "name": "blom",
                        "value": "Orange"
                    },
                    {
                        "name": "oiCode",
                        "value": "FTEL"
                    },
                    {
                        "name": "oiName",
                        "value": "Orange"
                    },
                    {
                        "name": "collectionTrafficRegionCode",
                        "value": "RHO"
                    },
                    {
                        "name": "collectionTrafficRegionLabel",
                        "value": "Rhône"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "Optimum Ethernet Entreprises",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                   {
                        "name": "blom",
                        "value": "Orange"
                    },
                    {
                        "name": "oiCode",
                        "value": "FTEL"
                    },
                    {
                        "name": "oiName",
                        "value": "Orange"
                    },
                    {
                        "name": "collectionTrafficRegionCode",
                        "value": "RHO"
                    },
                    {
                        "name": "collectionTrafficRegionLabel",
                        "value": "Rhône"
                    }
                ]
            }
        }
    ],
    "address": "",
    "additionalParameters": {
        "contract": "setiar"
    }
}

4. I want to check a site eligibility to Optimum offer (FTTE) from GPS coordinates

{
  "contextType": "geographiclocation",
  "category": {
    "name": "ftte"
  },
  "place": {
    "geographicLocation": {
      "x": "3.516726",
      "y": "50.319779"
    }
  }
}

5. I want to check a site eligibility to Optimum offer (FTTE) from a textual address

{
	"contextType": "fulltext",
	"category": {
		"name": "ftte"
	},
	"place": {
		"nonFormattedAddress": {
		  "fullText": "6 bis rue paul langevin 37300 joue les tours"
		}
	}
}

In case of unknowed textual address, I get :

{
    "code": 29,
    "message": "Address not found",
    "description": "The address is not found."
}

In case of imprecised textual address, I get :

{
    "code": 34,
    "message": "Multiple places found",
    "description": "Multiple instances found for fulltextadress, please reiterate your request with a more specific fulltext parameter."
}

6. I want to check a site eligibility to Optimum offer (FTTE) from building code

{
    "contextType": "buildingCode",
    "category": {
        "name": "ftte"
    },
    "publicKey": {
        "name": "buildingCode",
        "value": "IMB/31149/C/05B6"
    }
}

I get :

{
    "place": {
        "geographicSite": {
            "buildingCode": "IMB/31149/C/05B6",
            "address": "7 AVENUE YVES BRUNAUD, 31770 COLOMIERS",
            "normalizedAddress": {
                "inseeCode": "31149",
                "rivoliCode": "1350",
                "streetNr": "7",
                "streetNrSuffix": "",
                "streetType": "AVENUE",
                "streetName": "YVES BRUNAUD",
                "postcode": "31770",
                "city": "COLOMIERS",
                "geographicSubAddress": [
                    {
                        "buildingCode": "IMB/31149/C/05B6",
                        "geographicLocation": {
                            "longitude": 1.344731350255614,
                            "latitude": 43.615715858814944,
                            "accuracy": "building"
                        }
                    }
                ]
            }
        }
    },
    "address": "",
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "Optimum Access",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "nroCode",
                        "value": "31149COL"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "Optimum PM",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "pmCode",
                        "value": "FI-31149-001K"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "Optimum Ethernet",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                  {
                        "name": "blom",
                        "value": "Orange"
                    },
                    {
                        "name": "oiCode",
                        "value": "FTEL"
                    },
                    {
                        "name": "oiName",
                        "value": "Orange"
                    }
                ]
            }
        }
    ],
}

Use case examples for FTTH eligibility tests

Eligibility to Just Fibre (FTTH) from a textual address

I want to check eligibility FTTH from 17 RUE DU FAUBOURG POISSONNIERE 75009 PARIS

{
    "contextType": "fulltext",
    "category": {
        "name": "ftth"
    },
    "place": {
        "nonFormattedAddress": {
            "fullText": "17 RUE DU FAUBOURG POISSONNIERE 75009 PARIS"
        }
    }
}

I get :

{
    "contextType": "fulltext",
    "category": {
        "name": "ftth"
    },
    "place": {
        "nonFormattedAddress": {
            "fullText": "17 RUE DU FAUBOURG POISSONNIERE 75009 PARIS"
        }
    }
}

J'obtiens :

{
    "place": {
        "geographicSite": {
            "address": "17 RUE DU FAUBOURG POISSONNIERE, 75009 PARIS",
            "normalizedAddress": {
                "inseeCode": "75109",
                "rivoliCode": "3512",
                "streetNr": "17",
                "streetType": "RUE",
                "streetName": "DU FAUBOURG POISSONNIERE",
                "postcode": "75009",
                "city": "PARIS 09",
                "geographicSubAddress": [
                    {
                        "buildingCodeOC": "IMB/75109/C/000Q",
                        "buildingCodeOI": "IMB/75109/C/000Q",
                        "geographicLocation": {
                            "longitude": 2.347888,
                            "latitude": 48.872158,
                            "accuracy": "number"
                        }
                    }
                ]
            }
        }
    },
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "marketable",
            "productOffering": {
                "name": "FTTH Access",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "oiCode",
                        "value": "FTEL"
                    },
                    {
                        "name": "oiName",
                        "value": "Orange"
                    },
                    {
                        "name": "buildingManagerState",
                        "value": "PS"
                    },
                    {
                        "name": "buildingStatus",
                        "value": "DEPLOYE"
                    },
                    {
                        "name": "orderAcceptanceDate",
                        "value": "2018-01-23"
                    },
                    {
                        "name": "commercialLaunchDate",
                        "value": "2018-02-07"
                    },
                    {
                        "name": "siteType",
                        "value": "IMMEUBLE"
                    },
                    {
                        "name": "logementNumber",
                        "value": "1"
                    },
                    {
                        "name": "linkTypePBPTO",
                        "value": "SOUN"
                    },
                    {
                        "name": "pmCode",
                        "value": "FI-75109-00E1"
                    },
                    {
                        "name": "nroCode",
                        "value": "75109TRU"
                    },
                    {
                        "name": "collectionTrafficRegionCode",
                        "value": "IDF"
                    },
                    {
                        "name": "collectionTrafficRegionLabel",
                        "value": "Ile de France"
                    },
        

                    {
                        "name": "500M/1000M",
                        "value": "disponible"
                    },
                    {
                        "name": "800M/1000M",
                        "value": "disponible"
                    },
                    {
                        "name": "800M/2000M",
                        "value": "disponible"
                    },
                    {
                        "name": "2G/8G",
                        "value": "disponible a partir de"
                    },
                    {
                        "name": "4G/8G",
                        "value": "disponible a partir de"
                    },
                    {
                        "name": "8G/8G",
                        "value": "disponible a partir de"
                    },
                    {
                        "name": "provisionalDate2000/8000M",
                        "value": "01/07/2023"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "marketable",
            "productOffering": {
                "name": "Just Fibre",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "oiCode",
                        "value": "FTEL"
                    },
                    {
                        "name": "oiName",
                        "value": "Orange"
                    },
                    {
                        "name": "buildingManagerState",
                        "value": "PS"
                    },
                    {
                        "name": "buildingStatus",
                        "value": "DEPLOYE"
                    },
                    {
                        "name": "orderAcceptanceDate",
                        "value": "2018-01-23"
                    },
                    {
                        "name": "commercialLaunchDate",
                        "value": "2018-02-07"
                    },
                    {
                        "name": "siteType",
                        "value": "IMMEUBLE"
                    },
                    {
                        "name": "logementNumber",
                        "value": "1"
                    },
                    {
                        "name": "linkTypePBPTO",
                        "value": "SOUN"
                    },
                    {
                        "name": "pmCode",
                        "value": "FI-75109-00E1"
                    },
                    {
                        "name": "nroCode",
                        "value": "75109TRU"
                    }
                ]
            }
        }
    ],
    "address": "",
    "additionalParameters": {
        "contract": "setiar"
    }
}

Use case examples for FTTO eligibility tests

Here are few use cases of the API

The ressource and method used are the same as the FTTE offer. Only the value of the object category changes and has the value "ftto" instead of "ftte". For examples : Resource: /productOfferingQualification Méthode: POST

1. I want to check a site eligibility to FTTO offer from the following ND 03 27 29 48 47

{
  "contextType": "nd",
  "category": {
    "name": "ftto"
  },
  "publicKey": {
    "name": "nd",
    "value": "0327294847"
  }
}

I get :

{
    "place": {
        "geographicSite": {
            "normalizedAddress": {
                "inseeCode": "59221",
                "rivoliCode": "0260",
                "streetNr": "87A",
                "streetNrSuffix": "A",
                "geographicSubAddress": [
                    {
                        "geographicLocation": {
                            "longitude": 3.518307,
                            "latitude": 50.319761
                        }
                    }
                ]
            }
        }
    },
    "address": "",
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "noFiberSite",
            "productOffering": {
                "name": "Collecte Ethernet Optique Opérateurs",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "disponibilite",
                        "value": "sur étude de faisabilité"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "noFiberSite",
            "productOffering": {
                "name": "Core Ethernet Lan",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "zone",
                        "value": "O2"
                    },
                    {
                        "name": "100M",
                        "value": "disponible"
                    },
                    {
                        "name": "200M",
                        "value": "disponible"
                    },
                    {
                        "name": "300M-1G",
                        "value": "sur étude de faisabilité"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "noFiberSite",
            "productOffering": {
                "name": "Core Ethernet Entreprises",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "zone",
                        "value": "O2"
                    },
                    {
                        "name": "100M",
                        "value": "disponible"
                    },
                    {
                        "name": "200M",
                        "value": "disponible"
                    },
                    {
                        "name": "300M-1G",
                        "value": "sur étude de faisabilité"
                    }
                ]
            }
        }
    ]
}

2. I want to check a site eligibility to FTTO offer from a standardized address

{
  "contextType": "address",
  "category": {
    "name": "ftto"
  },
  "place": {
    "geographicAddress": {
      "rivoliCode": "0410",
      "cityCode": "01142"
    }
  }
}

I get :

{
    "place": {
        "geographicSite": {
            "normalizedAddress": {
                "inseeCode": "01142",
                "rivoliCode": "0410",
                "streetNr": "0",
                "geographicSubAddress": [
                    {
                        "geographicLocation": {
                            "longitude": 5.06154,
                            "latitude": 45.845392
                        }
                    }
                ]
            }
        }
    },
    "address": "",
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "fiberSite",
            "productOffering": {
                "name": "Collecte Ethernet Optique Opérateurs",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "disponibilite",
                        "value": "disponible"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "fiberSite",
            "productOffering": {
                "name": "Core Ethernet Lan",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "zone",
                        "value": "O3"
                    },
                    {
                        "name": "100M",
                        "value": "disponible"
                    },
                    {
                        "name": "200M",
                        "value": "disponible"
                    },
                    {
                        "name": "300M-1G",
                        "value": "disponible"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "fiberSite",
            "productOffering": {
                "name": "Core Ethernet Entreprises",
                "productSpecification": {}
            },
            "product": {
                "characteristics": [
                    {
                        "name": "zone",
                        "value": "O3"
                    },
                    {
                        "name": "100M",
                        "value": "disponible"
                    },
                    {
                        "name": "200M",
                        "value": "disponible"
                    },
                    {
                        "name": "300M-1G",
                        "value": "disponible"
                    }
                ]
            }
        }
    ]
}

3. I want to check a site eligibility to FTTO offer from GPS coordinates

{
  "contextType": "geographiclocation",
  "category": {
    "name": "ftto"
  },
  "place": {
    "geographicLocation": {
      "x": "3.516726",
      "y": "50.319779"
    }
  }
}

4. I want to check a site eligibility to FTTO offer from a textual address Functionality coming soon

Use case examples for Copper for Company eligibility tests

Here are few use cases of the API

The ressource and method used are the same for all examples: Resource: /productOfferingQualification Méthode: POST

Eligibility of an active ND

I want to check a site eligibility to Copper for Company offer from the following ND 01 23 45 67 89

{
  "contextType": "nd",
  "category": {
    "name": "cue"
  },
  "publicKey": {
    "name": "nd",
    "value": "0123456789"
  }
}

I get :

{
    "place": {
        "geographicSite": {
            "normalizedAddress": {
                "inseeCode": "59221",
                "rivoliCode": "0260",
                "streetNr": "87A",
                "streetNrSuffix": "A",
                "geographicSubAddress": [
                    {
                        "geographicLocation": {
                            "longitude": 3.518307,
                            "latitude": 50.319761
                        }
                    }
                ]
            }
        }
    },
    "address": "",
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "possible",
            "productOffering": {
                "name": "Accès Total Entreprises",
                "productSpecification": {
                    "name": "SDGPDEM"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "lineCharacteristics",
                        "value": "06 03015 | 04 00123"
                    },
                    {
                        "name": "siteCode",
                        "value": "59480 QUE"
                    },
                    {
                        "name": "availableCopperPair",
                        "value": "5"
                    },
                    {
                        "name": "maxAvailableCopperPairOnPC",
                        "value": "5"
                    },
                    {
                        "name": "networkReworkNra",
                        "value": "NO"
                    },
                    {
                        "name": "directLineDistribution",
                        "value": "NO"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "possible",
            "productOffering": {
                "name": "Core Ethernet Lan (SDSL)",
                "productSpecification": {
                    "name": "CEL05M"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "message",
                        "value": "neededPairs=1"
                    },
                    {
                        "name": "lineCharacteristics",
                        "value": "06 03015 | 04 00123"
                    },
                    {
                        "name": "siteCode",
                        "value": "59480 QUE"
                    },
                    {
                        "name": "context",
                        "value": "0"
                    },
                    {
                        "name": "availableCopperPair",
                        "value": "5"
                    },
                    {
                        "name": "maxAvailableCopperPairOnPC",
                        "value": "5"
                    },
                    {
                        "name": "ethernetRegion",
                        "value": "NORD PAS DE CALAIS"
                    },
                    {
                        "name": "lineType",
                        "value": "ND"
                    },
                    {
                        "name": "dslam",
                        "value": "HUAWEI"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "possible",
            "productOffering": {
                "name": "Core Ethernet Lan (SDSL)",
                "productSpecification": {
                    "name": "CEL1M"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "message",
                        "value": "neededPairs=1"
                    },
                    {
                        "name": "lineCharacteristics",
                        "value": "06 03015 | 04 00123"
                    },
                    {
                        "name": "siteCode",
                        "value": "59480 QUE"
                    },
                    {
                        "name": "context",
                        "value": "0"
                    },
                    {
                        "name": "availableCopperPair",
                        "value": "5"
                    },
                    {
                        "name": "maxAvailableCopperPairOnPC",
                        "value": "5"
                    },
                    {
                        "name": "ethernetRegion",
                        "value": "NORD PAS DE CALAIS"
                    },
                    {
                        "name": "lineType",
                        "value": "ND"
                    },
                    {
                        "name": "dslam",
                        "value": "HUAWEI"
                    }
                ]
            }
        },
    ...
    ]
}

Eligibility of a prestation number

I want to check a site eligibility to Copper for Company offer from a prestation number

{
  "contextType": "prestation",
  "category": {
    "name": "cue"
  },
  "publicKey": {
    "name": "prestation",
    "value": "9999ZZZ9"
  }
}

I get :

{
    "place": {
        "geographicSite": {
            "normalizedAddress": {
                "inseeCode": "13212",
                "rivoliCode": "8437",
                "streetNr": "555",
                "streetNrSuffix": "",
                "geographicSubAddress": [
                    {
                        "geographicLocation": {
                            "longitude": 5.421504,
                            "latitude": 43.290505
                        }
                    }
                ]
            }
        }
    },
    "address": "",
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "possible",
            "productOffering": {
                "name": "Accès Total Entreprises",
                "productSpecification": {
                    "name": "SDGPDEM"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "lineCharacteristics",
                        "value": "04 01947 | 06 02223"
                    },
                    {
                        "name": "siteCode",
                        "value": "13205 GAR"
                    },
                    {
                        "name": "availableCopperPair",
                        "value": "0"
                    },
                    {
                        "name": "maxAvailableCopperPairOnPC",
                        "value": "112"
                    },
                    {
                        "name": "networkReworkNra",
                        "value": "NO"
                    },
                    {
                        "name": "directLineDistribution",
                        "value": "NO"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "underCommercialTermsAndTechnicalReservations",
            "productOffering": {
                "name": "Core Ethernet Lan (SDSL)",
                "productSpecification": {
                    "name": "CEL05M"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "cause",
                        "value": "insufficientPairNumber"
                    },
                    {
                        "name": "message",
                        "value": "neededPairs=1"
                    },
                    {
                        "name": "lineCharacteristics",
                        "value": "04 01947 | 06 02223"
                    },
                    {
                        "name": "siteCode",
                        "value": "13205 GAR"
                    },
                    {
                        "name": "context",
                        "value": "0"
                    },
                    {
                        "name": "availableCopperPair",
                        "value": "0"
                    },
                    {
                        "name": "maxAvailableCopperPairOnPC",
                        "value": "112"
                    },
                    {
                        "name": "ethernetRegion",
                        "value": "PROVENCE"
                    },
                    {
                        "name": "dslam",
                        "value": "HUAWEI"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "underCommercialTermsAndTechnicalReservations",
            "productOffering": {
                "name": "Core Ethernet Lan (SDSL)",
                "productSpecification": {
                    "name": "CEL1M"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "cause",
                        "value": "insufficientPairNumber"
                    },
                    {
                        "name": "message",
                        "value": "neededPairs=2"
                    },
                    {
                        "name": "lineCharacteristics",
                        "value": "04 01947 | 06 02223"
                    },
                    {
                        "name": "siteCode",
                        "value": "13205 GAR"
                    },
                    {
                        "name": "context",
                        "value": "0"
                    },
                    {
                        "name": "availableCopperPair",
                        "value": "0"
                    },
                    {
                        "name": "maxAvailableCopperPairOnPC",
                        "value": "112"
                    },
                    {
                        "name": "ethernetRegion",
                        "value": "PROVENCE"
                    },
                    {
                        "name": "dslam",
                        "value": "HUAWEI"
                    }
                ]
            }
        },
    ...
    ]
}

Eligibility in housing area new buildings (ZLIN)

I want to check the eligibility to Copper for Company offer for a site in housing area new buildings (ZLIN)

{
    "contextType": "fulltext",
    "category": {
        "name": "cue"
    },
    "place": {
        "nonFormattedAddress": {
            "fullText": "58 AVENUE DE FRONTON, 31200 TOULOUSE"
        }
    }
}

I get notEligible/notFound result because this site is in housing area new buildings without copper lines :

{
    "address": "",
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "notEligible",
            "qualificationItemReason": "notFound",
            "productOffering": {
                "name": "Core Ethernet Entreprises (SDSL)",
                "productSpecification": {
                    "name": "WE05M"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "cause",
                        "value": "zlinZ0c"
                    }
                ]
            }
        }, ...

Case of a site in partially copper area

{
    "contextType": "address",
    "category": {
        "name": "cue"
    },
    "place": {
        "geographicAddress": {
            "rivoliCode": "6145",
            "cityCode": "92044",
            "streetNr": "68",
            "streetNrSuffix": "B"
        }
    },
    "additionalParameters": {
        "provideNumberIfNotUnique": true
    }
}

I get a list of copper lines with "zlin/zpc" information :

{
                        "buildingCharacteristics": [
                            {
                                "name": "floor",
                                "value": "04"
                            },
                            {
                                "name": "redList",
                                "value": "yes"
                            },
                            {
                                "name": "zlin",
                                "value": "zpc"
                            }
                        ],
                        "publicKey": {
                            "name": "nd",
                            "value": "0141066310"
                        }
                    },...

Note that in partially copper area, eligibility for copper offers will depend on the presence of the site in the copper area.

Use case examples for Copper for General Public eligibility tests

Here are few use cases of the API

The ressource and method used are the same for all examples: Resource: /productOfferingQualification Méthode: POST

1. I want to check a site eligibility to Copper for General Public offer from the following ND 01 23 45 67 89

{
  "contextType": "nd",
  "category": {
    "name": "cugp"
  },
  "publicKey": {
    "name": "nd",
    "value": "0123456789"
  }
}

I get :

{
    "place": {
        "geographicSite": {
            "normalizedAddress": {
                "inseeCode": "59221",
                "rivoliCode": "0260",
                "streetNr": "87A",
                "streetNrSuffix": "A",
                "geographicSubAddress": [
                    {
                        "geographicLocation": {
                            "longitude": 3.518307,
                            "latitude": 50.319761
                        }
                    }
                ]
            }
        }
    },
    "address": "",
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "underCommercialTermsAndTechnicalReservations",
            "productOffering": {
                "name": "DSL Access",
                "productSpecification": {
                    "name": "S7973"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "cause",
                        "value": "incompatibleService"
                    },
                    {
                        "name": "lineCharacteristics",
                        "value": "04 02198 | 06 02050"
                    },
                    {
                        "name": "siteCode",
                        "value": "59606 VAL"
                    },
                    {
                        "name": "context",
                        "value": "0"
                    },
                    {
                        "name": "lineType",
                        "value": "LS"
                    },
                    {
                        "name": "accessType",
                        "value": "ORD"
                    },
                    {
                        "name": "dslam",
                        "value": "ALCATEL,ECI,HUAWEI,LUCENT"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "underCommercialTermsAndTechnicalReservations",
            "productOffering": {
                "name": "DSL Access",
                "productSpecification": {
                    "name": "S7976"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "cause",
                        "value": "incompatibleService"
                    },
                    {
                        "name": "lineCharacteristics",
                        "value": "04 02198 | 06 02050"
                    },
                    {
                        "name": "siteCode",
                        "value": "59606 VAL"
                    },
                    {
                        "name": "context",
                        "value": "0"
                    },
                    {
                        "name": "lineType",
                        "value": "LS"
                    },
                    {
                        "name": "accessType",
                        "value": "ORD"
                    },
                    {
                        "name": "dslam",
                        "value": "ALCATEL,ECI,HUAWEI,LUCENT"
                    }
                ]
            }
        },
    ...
    ]
}

Use case example for Company Copper with multiple ND, precable numbers and prestation numbers

1. I want to obtain eligibility for Copper for General Public on one of the ND of a site from its textual address

{
    "contextType": "fulltext",
    "category": {
        "name": "cugp"
    },
    "place": {
        "nonFormattedAddress": {
            "fullText": "7 RUE DE LISBONNE, 93110 ROSNY SOUS BOIS"
        }
    },
    "additionalParameters": {
        "provideNumberIfNotUnique": true
    }
}

I get the list of copper lines at this address :

{
    "place": {
        "geographicSite": {
            "address": "7 RUE DE LISBONNE, 93110 ROSNY SOUS BOIS",
            "normalizedAddress": {
                "inseeCode": "93064",
                "rivoliCode": "5159",
                "streetNr": "7",
                "streetType": "RUE",
                "streetName": "DE LISBONNE",
                "postcode": "93110",
                "city": "ROSNY SOUS BOIS",
                "geographicSubAddress": [
                    {
                        "geographicLocation": {
                            "longitude": 2.475754,
                            "latitude": 48.878271,
                            "accuracy": "number"
                        },
                        "buildingCharacteristics": [
                            {
                                "name": "accessType",
                                "value": "ORD"
                            },
                            {
                                "name": "lineCharacteristics",
                                "value": "04 00783"
                            },
                            {
                                "name": "lineType",
                                "value": "LS"
                            },
                            {
                                "name": "redList",
                                "value": "yes"
                            },
                            {
                                "name": "residence",
                                "value": "ZAC DE NANTEUIL"
                            }
                        ],
                        "publicKey": {
                            "name": "nd",
                            "value": "0145280661"
                        }
                    },
                    {
                        "buildingCharacteristics": [
                            {
                                "name": "accessType",
                                "value": "ORD"
                            },
                            {
                                "name": "lineCharacteristics",
                                "value": "04 00783"
                            },
                            {
                                "name": "lineType",
                                "value": "LS"
                            },
                            {
                                "name": "redList",
                                "value": "yes"
                            },
                            {
                                "name": "residence",
                                "value": "CHEZ LEROY MER"
                            }
                        ],
                        "publicKey": {
                            "name": "nd",
                            "value": "0145289201"
                        }
                    },
                    {
                        "buildingCharacteristics": [
                            {
                                "name": "accessType",
                                "value": "ORD"
                            },
                            {
                                "name": "lineCharacteristics",
                                "value": "04 00783"
                            },
                            {
                                "name": "lineType",
                                "value": "LS"
                            },
                            {
                                "name": "redList",
                                "value": "yes"
                            },
                            {
                                "name": "residence",
                                "value": "POSTE EDF MAGIQUE"
                            }
                        ],
                        "publicKey": {
                            "name": "nd",
                            "value": "0148541610"
                        }
                    },
                    ...
                ]
            }
        }
    },
    "address": "",
    "qualificationResult": "notComputed",
    "productOfferingQualificationItem": []
}
}

I specify my previous request with the desired ND :

{
    "contextType": "nd",
    "category": {
        "name": "cugp"
    },
    "publicKey": {
        "name": "nd",
        "value": "0148541610"
    }
}

I get the result of eligibility for the general public copper offers :

{
    "place": {
        "geographicSite": {
            "address": "7 RUE DE LISBONNE, 93110 ROSNY SOUS BOIS",
            "normalizedAddress": {
                "inseeCode": "93064",
                "rivoliCode": "5159",
                "streetNr": "7",
                "streetNrSuffix": "",
                "streetType": "RUE",
                "streetName": "DE LISBONNE",
                "postcode": "93110",
                "city": "ROSNY SOUS BOIS",
                "geographicSubAddress": [
                    {
                        "geographicLocation": {
                            "longitude": 2.475754,
                            "latitude": 48.878271,
                            "accuracy": "number"
                        },
                        "buildingCharacteristics": [
                            {
                                "name": "residence",
                                "value": "POSTE EDF MAGIQUE"
                            }
                        ],
                        "publicKey": {
                            "name": "nd",
                            "value": "0148541610"
                        }
                    }
                ]
            }
        }
    },
    "address": "",
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "possible",
            "productOffering": {
                "name": "DSL Access",
                "productSpecification": {
                    "name": "S7973"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "message",
                        "value": "redList"
                    },
                    {
                        "name": "lineCharacteristics",
                        "value": "04 00783"
                    },
                    {
                        "name": "siteCode",
                        "value": "93064 RNY"
                    },
                    {
                        "name": "context",
                        "value": "0"
                    },
                    {
                        "name": "lineType",
                        "value": "LS"
                    },
                    {
                        "name": "accessType",
                        "value": "ORD"
                    },
                    {
                        "name": "dslam",
                        "value": "ALCATEL,ECI,HUAWEI"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "possible",
            "productOffering": {
                "name": "DSL Access",
                "productSpecification": {
                    "name": "S7976"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "message",
                        "value": "redList"
                    },
                    {
                        "name": "lineCharacteristics",
                        "value": "04 00783"
                    },
                    {
                        "name": "siteCode",
                        "value": "93064 RNY"
                    },
                    {
                        "name": "context",
                        "value": "0"
                    },
                    {
                        "name": "lineType",
                        "value": "LS"
                    },
                    {
                        "name": "accessType",
                        "value": "ORD"
                    },
                    {
                        "name": "dslam",
                        "value": "ALCATEL,ECI,HUAWEI"
                    }
                ]
            }
        },
        ...
    ]
}

Example of use cases with a SETIAR contract

For operators with a SETIAR contract, the API returns the name of the line holder, the contact details of the Pcs as well as the neighbouring addresses.

Eligibility of an address on the street number

{
  "contextType": "address",
  "category": {
    "name": "cue"
  },
  "place": {
    "geographicAddress": {
      "streetNr": "6",
      "streetNrSuffix":"B",
      "rivoliCode": "4913",
      "cityCode": "75111"
    }
  },
  "additionalParameters": {
  	"provideNumberIfNotUnique": true,
  	"useSetiar": true
  }
}

If I have not signed a SETIAR contract, I get an answer in error :

{
    "code": 51,
    "message": "useSetiar needs a SETIAR subscription, please contact your salesperson"
}

If I have signed a SETIAR contract, I obtain the name of the holder of the line, the list of ND active/inactive, precable, PC, address supplements and the postal address :

{
    "contract": "setiar",
    "place": {
        "geographicSite": {
            "normalizedAddress": {
                "inseeCode": "75111",
                "rivoliCode": "4913",
                "streetNr": "6",
                "streetNrSuffix":"B",
                "geographicSubAddress": [
                    {
                        "buildingName": "B",
                        "buildingCharacteristics": [
                            {
                                "name": "customerName",
                                "value": "nom prénom 1"
                            },
                            {
                                "name": "building",
                                "value": "B"
                            },
                            {
                                "name": "floor",
                                "value": "00"
                            },
                            {
                                "name": "residence",
                                "value": "RES DARDILLY"
                            },
                            {
                                "name": "logo",
                                "value": "0B002"
                            },
                            {
                                "name": "pc",
                                "value": "0"
                            }
                        ],
                        "publicKey": {
                            "name": "nd",
                            "value": "05xxxxxxxx"
                        }
                    },
                    {
                        "buildingName": "B",
                        "buildingCharacteristics": [
                            {
                                "name": "customerName",
                                "value": "nom prénom 2"
                            },
                            {
                                "name": "building",
                                "value": "B"
                            },
                            {
                                "name": "floor",
                                "value": "01"
                            },
                            {
                                "name": "residence",
                                "value": "RES DARDILLY"
                            },
                            {
                                "name": "logo",
                                "value": "0C003"
                            },
                            {
                                "name": "plpClass",
                                "value": "021"
                            },
                            {
                                "name": "lineUnderConstruction",
                                "value": "yes"
                            },
                            {
                                "name": "pc",
                                "value": "0"
                            }
                        ],
                        "publicKey": {
                            "name": "ndetoile",
                            "value": "04xxxxxxxx"
                        }
                    },
                    {
                        "buildingName": "B",
                        "buildingCharacteristics": [
                            {
                                "name": "customerName",
                                "value": "nom prénom 3"
                            },
                            {
                                "name": "building",
                                "value": "B"
                            },
                            {
                                "name": "floor",
                                "value": "03"
                            },
                            {
                                "name": "residence",
                                "value": "RES DARDILLY"
                            },
                            {
                                "name": "logo",
                                "value": "0D003"
                            }
                        ],
                        "publicKey": {
                            "name": "precable",
                            "value": "42CLK000000000013826"
                        }
                    },
                    ...
                ]
            }
        },
        "address": "6 BIS RUE JEAN MACE, 75011 PARIS 11"
    },
    "additionalParameters":{
    	"places":[
    		{
    			"status":"pc",
    			"geographicSite":{
    				"normalizedAddress": {
						"inseeCode": "75111",
						"rivoliCode": "4913",
						"streetNr": "6",
						"streetNrSuffix":"B",
			    		"geographicSubAddress":{
							"geographicLocation": {
			                    "longitude": 4.763361,
			                    "latitude": 45.821453
			                }
						}
            		},
        			"address": "6 BIS RUE JEAN MACE, 75011 PARIS 11"
				}
    		},
    		{
    			"status":"pc",
    			"geographicSite":{
    				"normalizedAddress": {
						"inseeCode": "75111",
						"rivoliCode": "4913",
						"streetNr": "6",
						"streetNrSuffix":"B",
                		"geographicSubAddress":{
							"geographicLocation": {
	                            "longitude": 4.763365,
	                            "latitude": 45.821458
	                        }
            			}
            		},
        			"address": "6 BIS RUE JEAN MACE, 75011 PARIS 11"
				}
    		}
    	}
    }
    "address": "",
    "qualificationResult": "notComputed",
    "productOfferingQualificationItem": []
}

Eligibility of an address with restitution of other street numbers

I want to choose a ND or a precablé on another street number :

{
  "contextType": "address",
  "category": {
    "name": "cue"
  },
  "place": {
    "geographicAddress": {
      "streetNr": "6",
      "streetNrSuffix":"B",
      "rivoliCode": "4913",
      "cityCode": "75111"
    }
  },
  "additionalParameters": {
  	"provideNumberIfNotUnique": true,
  	"useSetiar": true,
  	"searchType": "street"
  }
}

I get the list of the ND/pre-cabled of the other street n° in the additionalParameters.places[] array :

...
{
	"status":"neighbour",
	"geographicSite":{
		"normalizedAddress": {
			"inseeCode": "75111",
			"rivoliCode": "4913",
			"streetNr": "7",
            "geographicSubAddress": [
        		{
                    "buildingName": "A",
                    "buildingCharacteristics": [... nom du titulaire, PC ...],
                    "publicKey": {
                        "name": "ndetoile",
                        "value": "0504xxxxxx"
            		}
        		}
            "address": "7 RUE JEAN MACE, 75011 PARIS 11"
		}
    }
}
...

Eligibility of a neighbouring address

I want to choose a copper line from those served by the PC that serve this address :

{
  "contextType": "address",
  "category": {
    "name": "cue"
  },
  "place": {
    "geographicAddress": {
      "streetNr": "6",
      "streetNrSuffix":"B",
      "rivoliCode": "4913",
      "cityCode": "75111"
    }
  },
  "additionalParameters": {
  	"provideNumberIfNotUnique": true,
  	"useSetiar": true,
  	"searchType": "neighbour"
  }
}

I get the list of copper lines addresses in the additionalParameters.places[] array :

...
{
    "status":"neighbour",
    "geographicSite":{
        "normalizedAddress": {
            "inseeCode": "75111",
            "rivoliCode": "4913",
            "streetNr": "7",
            "geographicSubAddress": [
                {
                    "buildingName": "A",
                    "buildingCharacteristics": [... nom du titulaire, PC ...],
                    "publicKey": {
                        "name": "ndetoile",
                        "value": "0504xxxxxx"
            		}
        		}
            "address": "7 RUE JEAN MACE, 75011 PARIS 11"
		}
    }
},
{
    "status":"neighbour",
    "geographicSite":{
        "normalizedAddress": {
            "inseeCode": "75111",
            "rivoliCode": "1762",
            "streetNr": "14",
            "geographicSubAddress": [
                {
                    "buildingName": "A",
                    "buildingCharacteristics": [... nom du titulaire, PC ...],
                    "publicKey": {
                        "name": "nd",
                        "value": "0589xxxxxx"
                    },
        	"address": "14 RUE CHANZY, 75011 PARIS 11"
        }
    }
},
{
    "status":"neighbour",
    "geographicSite":{
        "normalizedAddress": {
            "inseeCode": "75111",
            "rivoliCode": "1762",
            "streetNr": "24",
            "geographicSubAddress": [
                {
                    "buildingCharacteristics": [... nom du titulaire, PC ...],
                    "publicKey": {
                        "name": "ndetoile",
                        "value": "0577xxxxxx"
                    },
        	"address": "24 RUE CHANZY, 75011 PARIS 11"
        }
    }
}
...

Case of a building whose PC only uses this address :

{
    "contextType": "fulltext",
    "category": {
        "name": "cue|cugp|vg"
    },
    "place": {
        "nonFormattedAddress": {
            "fullText": "19 RUE MAURICE PETIT 69360 SEREZIN DU RHONE"
        }
    },
    "additionalParameters": {
        "provideNumberIfNotUnique": true,
        "useSetiar": true,
        "searchType": "neighbour"
    }
}

All the returned copper lines are on 19 RUE MAURICE PETIT 69360 SEREZIN DU RHONE because the PC only uses this address.

Eligibility of an address by targeting an address element

I want to test the eligibility of an address with additional criteria: the search can include residence, building, floor, stair, door, logo and customerName.

{
	"contextType": "address",
	"category": {
		"name": "cue"
	},
	"place": {
	    "geographicAddress": {
			"streetNr": "6",
			"streetNrSuffix":"B",
			"rivoliCode": "4913",
			"cityCode": "75111",
			"geographicSubAddress":{
			"buildingCharacteristics":[
				{
					"name":"residence",
					"value":"OISEAUX"
				},
				{
					"name":"customerName",
					"value":"nom prénom"
				},
				{
					"name":"logo",
					"value":"0K092"
				}
			]}
    	}
	},
	"additionalParameters":	{
		"provideNumberIfNotUnique": true,
		"useSetiar": true
	  }
}

Search for PC

I want to see the list of Pcs at an address :

{
  "contextType": "address",
  "category": {
    "name": "pc"
  },
  "place": {
    "geographicAddress": {
      "streetNr": "6",
      "streetNrSuffix":"B",
      "rivoliCode": "4913",
      "cityCode": "75111"
    }
  },
  "additionalParameters": {
  	"provideNumberIfNotUnique": true,
  	"useSetiar": true
  }
}

I get the PC list in the additionalParameters.places[] array:

...
{
	"status":"pc",
	"geographicSite":{
		"normalizedAddress": {
			"inseeCode": "75111",
			"rivoliCode": "4913",
			"streetNr": "6",
			"streetNrSuffix":"B",
    		"geographicSubAddress":[{
				"geographicLocation": {
                    "longitude": 4.763361,
                    "latitude": 45.821453
                },
    			"buildingCharacteristics": [{
    				...,
                    {
                    	"name": "type",
                        "value": "IM"
                    },
                    {
                    	"name": "availableCopperPair",
                        "value": "7"
                    },
                    ...
				}]
		}
	}
},
{
	"status":"pc",
	"geographicSite":{
		"normalizedAddress": {
			"inseeCode": "75111",
			"rivoliCode": "4913",
			"streetNr": "6",
			"streetNrSuffix":"B",
    		"geographicSubAddress":[{
				"geographicLocation": {
                    "longitude": 4.763361,
                    "latitude": 45.821453
                },
    			"buildingCharacteristics": [{
    				...,
                    {
                    	"name": "type",
                        "value": "DF"
                    },
                    {
                    	"name": "availableCopperPair",
                        "value": "2"
                    },
                    ...
				}]
			}]
		}
	}
}
...

I want to see the list of Pcs of the other street no. (note that the search at the neighboring addresses is not possible) :

{
  "contextType": "address",
  "category": {
    "name": "pc"
  },
  "place": {
    "geographicAddress": {
      "streetNr": "6",
      "streetNrSuffix":"B",
      "rivoliCode": "4913",
      "cityCode": "75111"
    }
  },
  "additionalParameters": {
  	"provideNumberIfNotUnique": true,
  	"useSetiar": true,
  	"searchType": "street"
  }
}

Use case examples for Wholesale eligibility tests

The ressource and method used are the same as the over offer. Only the value of the object category changes with vg.

Eligibility from textual address

1. I want to obtain eligibility for Wholesale offers for a site from a textual address

{
	"contextType": "fulltext",
	"category": {
		"name": "vg"
	},
	"place": {
		"nonFormattedAddress": {
		  "fullText": "6 bis rue paul langevin 37300 joue les tours"
		}
	}
}

I get :

{
    "place": {
        "geographicSite": {
            "normalizedAddress": {
                "inseeCode": "37122",
                "rivoliCode": "1353",
                "streetNr": "6B",
                "streetNrSuffix": "B",
                "geographicSubAddress": [
                    {
                        "geographicLocation": {
                            "longitude": 0.660787,
                            "latitude": 47.344727,
                            "accuracy": "street"
                        }
                    }
                ]
            }
        }
    },
    "address": "",
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "underCommercialTermsAndTechnicalReservations",
            "productOffering": {
                "name": "Vente en Gros",
                "productSpecification": {
                    "name": "VG4000"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "cause",
                        "value": "compatibilityToCheck"
                    },
                    {
                        "name": "message",
                        "value": "multipleNd;redList;noNewPSTNLine"
                    },
                    {
                        "name": "lineCharacteristics",
                        "value": "04 00782"
                    },
                    {
                        "name": "siteCode",
                        "value": " "
                    },
                    {
                        "name": "availableCopperPair",
                        "value": "2"
                    },
                    {
                        "name": "maxAvailableCopperPairOnPC",
                        "value": "2"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "underCommercialTermsAndTechnicalReservations",
            "productOffering": {
                "name": "Vente en Gros",
                "productSpecification": {
                    "name": "VG4001"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "cause",
                        "value": "compatibilityToCheck"
                    },
                    {
                        "name": "message",
                        "value": "multipleNd;redList;noNewPSTNLine"
                    },
                    {
                        "name": "lineCharacteristics",
                        "value": "04 00782"
                    },
                    {
                        "name": "siteCode",
                        "value": " "
                    },
                    {
                        "name": "availableCopperPair",
                        "value": "2"
                    },
                    {
                        "name": "maxAvailableCopperPairOnPC",
                        "value": "2"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "underCommercialTermsAndTechnicalReservations",
            "productOffering": {
                "name": "Vente en Gros",
                "productSpecification": {
                    "name": "VG4002"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "cause",
                        "value": "compatibilityToCheck"
                    },
                    {
                        "name": "message",
                        "value": "multipleNd;redList;noNewPSTNLine"
                    },
                    {
                        "name": "lineCharacteristics",
                        "value": "04 00782"
                    },
                    {
                        "name": "siteCode",
                        "value": " "
                    },
                    {
                        "name": "availableCopperPair",
                        "value": "2"
                    },
                    {
                        "name": "maxAvailableCopperPairOnPC",
                        "value": "2"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "underCommercialTermsAndTechnicalReservations",
            "productOffering": {
                "name": "Vente en Gros",
                "productSpecification": {
                    "name": "VG4003"
                }
            },
            "product": {
                "characteristics": [
                    {
                        "name": "cause",
                        "value": "compatibilityToCheck"
                    },
                    {
                        "name": "message",
                        "value": "multipleNd;redList;noNewPSTNLine"
                    },
                    {
                        "name": "lineCharacteristics",
                        "value": "04 00782"
                    },
                    {
                        "name": "siteCode",
                        "value": " "
                    },
                    {
                        "name": "availableCopperPair",
                        "value": "2"
                    },
                    {
                        "name": "maxAvailableCopperPairOnPC",
                        "value": "2"
                    }
                ]
            }
        }
    ]
}

In case of unknown textual address, I get :

{
    "code": 29,
    "message": "Address not found",
    "description": "The address is not found."
}

In case of imprecise textual address, I get :

{
    "code": 34,
    "message": "Multiple places found",
    "description": "Multiple instances found for fulltextadress, please reiterate your request with a more specific fulltext parameter."
}

Use case example of eligibility test in 1 call for Copper and Wholesale offers

For Copper and Wholesale offers, the category.name field allows the entry of several categories separated by the character "|" ex. cugp|cue.