Eligibility - API Documentation

1.1

• 1.1 (current)
• 1.0 (deprecated)

Eligibility API Resources

Table of Contents

• Prerequisite authentication
• Base URL
• Method and URL
• Input
• Output
• Examples
• Errors

Prerequisite authentication

API Key

The API requires an API-Key to access to it

• Your Orange Business representative will provide you this API key.
• The API key must be added to HTTP headers of each API call.
• It has to be put in the X-Api-Key header.
• The API requires also the generation of an API-Key. API-Key expires after 2 years and must be renewed by asking to Orange Support.

oAuth2

The access to this API is secured by the OAuth 2.0 framework with the Client Credentials grant type, which means that you will have to present an OAuth 2.0 access_token whenever you want to request this API.

It's easy to negotiate this access_token: just send a request to the proper token negotiation endpoint, with a Basic Authentication header valued with your own client_id and client_secret.

For this API, the token negotiation endpoint is:

https://api.orange.com/oauth/v3/token

        
        Copied 
      

A technical guide is available to learn how to negotiate and manage these access_token.

Important

• Please pay particular attention to properly handle authentication error responses in your application. See the section Errors
• The access_token default lifetime is 60 minutes.
• Header Accept: application/json is now required, when it’s omitted you will receive an error 406 error.

Base URL

The Base URL is the first part of the full invocation URL, just before the resource paths. Whenever you make requests on this API, you will need to prepend the following Base URL to the resource paths defined for this API.

If you request this API and encounter a 404 NOT FOUND HTTP error response, please check first that the Base URL is correct.

The Base URL for this API is:

https://api.orange.com/eligibility/b2b/v1/

        
        Copied 
      

Method and URL

Input

This API is designed to calculate the eligibility for fiber and mobile supports based on the provided query parameters:

• fullTextAddress: The full text address to search for
• buildingCode: The building code
• geoCoding coordinates : The geographic latitude and longitude coordinates of the location
• ND: The landline number associated with the location

The API allows two types of fiber eligibility checks via the following parameter:

• allforwan: If set to true, the API calculates eligibility for Dedicated Fiber instead of FTTE/FTTO, Shared Fiber instead of FTTH and MOBILE. Otherwise, the API determines eligibility for FTTH, FTTE, FTTO and MOBILE.

Note: Since December 3, the API response will switch to returning eligibility for Dedicated Fiber and Shared Fiber.

        
        Copied 
      

Eligibility check by Address

Note:
- If there are matching POIs, the API will return a list of POIs corresponding to the provided address.
- If no matching address is found, the API will return "404 Not Found" Error.
- If the  buildingName is specified as a parameter for the request, the API will search for the specified building name within the provided address:
    - If a matching building is found, the API will retrieve the building code and calculate the eligibility, and return the corresponding POI.
    - If no matching building is found, the API will return an appropriate error message.

        
        Copied 
      

Eligibility check by buildingCode

Note:
- If there is a matching POI, the API will return the POI corresponding to the provided building code.
- If no matching building code is found, the API will return "404 Not Found" Error.

        
        Copied 
      

Eligibility check by geographic coordinates

Eligibility check by ND

Note:
- If there is a matching POI, the API will return the POI corresponding to the provided ND.
- If no matching ND is found, the API will return "404 Not Found" Error.

        
        Copied 
      

Output

A Point of Interest (POI) represents a geographic location that can either be an address or a building. Each POI contains information about the eligibility of Fiber and Mobile supports.

|---comments|Array of strings|An array of comments related to the shared fiber service availability.| |---properties|Object (sharedFiberProperties)|Contains properties related to the shared fiber service.| |----oiName|String|shared fiber Properties: Indicates the building operator responsible for the installation and management of the shared fiber within buildings.| |--dedicated_fiber|Object|Support: Contains information about dedicated fiber service availability.| |---status|String|The eligibility status of dedicated fiber service at the point of interest. Possible values: eligible, notEligible, notComputed| |---properties|Object (dedicatedFiberProperties)|Contains properties related to the dedicated fiber service.| |----isOptimalAvailable|Boolean|Dedicated fiber Properties: Indicates whether the optimal fiber service is available at the point of interest.| |----oiName|String|Dedicated fiber Properties: Indicates the building operator responsible for the installation and management of the dedicated fiber within buildings| |----isFiberAvailable|Boolean|Dedicated fiber Properties: Indicates whether the dedicated fiber service is available| |----zoning|String|Dedicated fiber Properties: Indicate the zoning information.| |-mobile|Object|Contains informations about each mobile technologie.| |--mobileTechnologies|Array of strings|Contains mobile technologie coverage details | |---technology|String|Name of the Mobile technology; Possible values: 2G, 3G, 3G900, 3G2K, 4G, 5G, 5G2100, 5G3500, LORA, PMR, LTEM, LTEM-EC.| |---quality|String|Level of mobile coverage quality. Possible values: Excellent coverage, Very good coverage, Good coverage, Average coverage, No coverage.| |---coverageQualityScore|String|Coverage quality. Values: 0, 1, 2, 3, 4 in relation to coverage quality: 0: No coverage. 4: Excellent coverage.| |---message|String|Information on coverage quality; Possible values: Your mobile device should work outdoors and in most cases indoors as well., Your mobile device should operate outdoors and, in some cases, indoors.,Your mobile device should operate in most cases outdoors and, in some cases, indoors.,Your mobile device should operate in most cases outdoors but probably not indoors.,Your mobile device should not operate either outdoors or indoors.| |createdAt|String|PointOfInterest: The date and time when the point of interest record was created.| |updatedAt|String|PointOfInterest: The date and time when the point of interest record was last updated.|

Examples

Eligibility API examples

Errors

Consult all generic errors.