.wpb_animate_when_almost_visible { opacity: 1; }
RIP Operator Eligibility France
Orange offers availability for RIP operators
1.0

Getting started



Introduction

This API allows to check the elibibility to FTTE and FTTH 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

It is requested to sign a contract with the marketing department of Orange Public Initiative Networks to access this service.

The RIP API Operator Eligibility enables to deliver eligibility through the e-service Operator Eligibility available in the "Espace Opérateurs RIP"

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/ripoperatoreligibility/v1

Methods and URL

RessourceMethodDescription
/productRIPQualificationPOSTCheck eligibility of an access to optic fiber offers for a given site based a several criteria.

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/ripoperatoreligibility/v1/productRIPQualification

Glossary

AccronymeDefinition
NDDesignation Number. 10-digit number of a telephone service subscriber.
Prestation number8 characters.
FTTEFiber To The Entreprise (Mutualized Optical local loop).
FTTHFiber To The Home (Mutualized Optical local loop).

Service description

Ressources and entry parameters

ParametersTypeDescription
contextTypeStringThe contextType field is used to define how to test the site eligibility. This field must be populated with one of the following values: nd for active ND (if the ND is inactive, the test will automatically be on the inactive ND), ndetoile for inactive ND, address, fulltext, geographiclocation, prestation, precable. In case of a move in progress : an active ND points to the new address, an inactive ND points to the previous address, an active ND can therefore be active (on the new address) and inactive (on the previous address), an active ND cannot be active on several addresses
categoryObjectThe category object must always be entered to determine the offer to be tested
--.nameStringThe category.name field determines the offer covered by the test. It must be entered with the following values : ftte for FTTE offer, ftth for FTTH offer.
publicKeyObjectThe publicKey object is mandatory for a search by contextType = nd, precable, prestation or buildingCode.
--.nameStringThe publicKey.name field must be filled with the nd, prestation or precable value.
--.valueStringThe publicKey.value field must contain either the ND on which an eligibility test is done (The ND must begin with 01, 02, 03, 04 ou 05 and contain a total of 10 digits, example: "0123456789") or the prestation number (8 uppercase characters, example : "9999ZZZ9") or the precable number or the building code (example: IMB/99999/X/0099).
placeObjectThe place object contains all the information for a query by address or geolocation.
--.geographicAddressObjectThe geographicAddress object is required to perform a test based on a standardized address.
--.--.streetNrStringThe streetNr field contains the street number.
--.--.streetNrSuffixStringThe streetNrSuffix field contains the suffix of the street number (A, B, C, bis, ter, etc).
--.--.rivoliCodeStringThe rivoliCode field contains the 4 alphanumeric (999F) Rivoli code.
--.--.cityCodeStringThe cityCode field contains the 5 alphanumeric INSEE code (59221, 2A004).
--.--.geographicSubAddressObjectIf multiple buildings or precable numbers are located at the same address, the geographicSubAddress object is used to specify the building code or target copper line number.
--.--.--.buildingCodeStringThe buildingCode field contains the buiding code for an address with several buildings.
--.geographicLocationObjectThe geographicLocation object is required to perform a test based on geographical coordinates.
--.--.xStringThe x field contains the longitude of a site whose value is between -180 and 180 and can not contain more than 10 digits after the decimal point.
--.--.yStringThe y field contains the latitude of a site whose value is between -90 and 90 and can not contain more than 10 digits after the decimal point.
--.nonFormattedAddressObjectThe nonFormattedAddress object is required to perform a test based on textual address.
--.--.fulltextStringThe fulltext field contains the textual address. To optimize successful return, the format should be "[streetNr] [streetNrSuffix] [streetName] [postCode] [city]" in lowercase without accent and ponctuation. Note that the "address" field of the Operator Eligibility e-service uses the same rules. As a reminder, it is preferable to use the normalized address to target an address accurately.

Output parameters

ParametersTypeDescription
placeObjectThe place object is set if an offer is available. It contains the geographicSite object.
--.geographicSiteObjectThe geographicSite objet contains the address on which the availability test has been done. It can be different than the input address and it contains the address and the normalizedAddress fields.
--.--.addressStringContains the textual address.
--.--.normalizedAddressObjectThe normalizedAddress object contains the standardized address (inseeCode, rivoliCode, streetNr, streetNrSuffix), the textual address cut out and additional information from the address geographicSubAddress.
--.--.--.inseeCodeStringThe inseeCode contains the INSEE codefield contains the 5 alphanumeric INSEE code (59221, 2A004).
--.--.--.rivoliCodeStringThe rivoliCode field contains the 4 alphanumeric (999F) Rivoli code.
--.--.--.streetNrStringThe streetNr field contains the street number and streetNrSuffix only for FTTE offers (ex. "3C").
--.--.--.streetNrSuffixStringThe streetNrSuffix field contains the suffix of the street number (bis, ter, ...).
--.--.--.streetTypeStringContains the street type
--.--.--.streetNameStringContains the street name
--.--.--.postcodeStringContains the postcode
--.--.--.localityStringContains locality type (ex : "lieu dit")
--.--.--.cityStringContains city name
--.--.--.geographicSubAddressArrayThe geographicSubAddress contains additional information from the address. It will contain a list if multiple buildings or copper lines are located at the same address (see qualificationResult=notComputed).
--.--.--.--.buildingNameStringOn FTTE OR FTTH offers only. The buildingName field contains the buiding code for an address with several buildings.
--.--.--.--.buildingCodeStringOn FTTE OR FTTH offers only. The buildingCode field contains the buiding code for an address with several buildings.
--.--.--.--.geographicLocationObjectThe geographicLocation object contains the geographical coordinates with the accuracy level of the geolocation : longitude, latitude and accuracy.
--.--.--.--.--.longitudeDoubleThe longitude field contains the longitude of a site whose value is between -180 and 180 and can not contain more than 15 digits after the decimal point.
--.--.--.--.--.latitudeDoubleThe latitude field contains the latitude of a site whose value is between -90 and 90 and can not contain more than 15 digits after the decimal point.
--.--.--.--.--.accuracyStringThe accuracy field contains the street, number or building value which determines the level of accuracy.
qualificationResultStringThe qualificationResult field is set with notComputed value when there is more than one building at the same address : the productOfferingQualificationItem field will be then empty and the geographicSubAddress field will contain the additional information from returned addresses.
productOfferingQualificationItemArrayThe productOfferingQualificationItem field contain an array of values ??with the fields qualificationItemResult, qualificationItemReason, productOffering and product.
--.qualificationItemResultStringThe qualificationItemResult field contains the availability result. It returns one the following values: eligible or notEligible.
--.qualificationItemReasonStringThe qualificationItemReason field contains the detailed information of availability. Possible values for FTTE : deployed, partiallyDeployed, deploying, notDeployed, notFound. Possible values for FTTH : marketable, linkable, notYetAvailable, deployingBuildingSoon, deployedDistrict, deployingDistrict, deployingDistrictSoon, deployingCity, notDeployed, notFound.
--.productOfferingObjectThe productOffering object contains information of an offer.
--.--.nameStringThe name field contains the name of the offer bearing the eligibility result. Possible values for FTTE : FTTE passif PM, FTTE passif NRO, FTTE active Entreprises, FTTE active LAN. Possible values for FTTH : Accès aux lignes FTTH, FTTH activé.
--.productObjectThe product field contains the characteristics array.
--.--.characteristicsArrayThe characteristics field contains an array of characteristics about the offer. It includes values of name and value
--.--.--.nameStringThe name field contains the characteristic's name
--.--.--.valueStringThe value field contains the characteristic's value

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

FTTE offers characteristics

Characteristic's nameAssociated offerDescription
nroCodeFTTE passif NRONRO code (ie: 59480QUE)
pmCodeFTTE passif PMPM code (ie: FI-59221-000D)
messageAllIf the PM is part of the 2020 retrieval plan, the message will be set to 2020_retrieval_plan until the PM is resumed
coverageAreaFTTE Active LAN, FTTE Active EntrepriseZone de couverture
blomAllBoucle Locale Optique Mutualisee (ex : Orange, Vendee Numerique)
oiCodeAllInfrastructure operator code PIN (Public Initiative Network)

FTTH offers characteristics

Characteristic's nameAssociated offerDescription
causeFTTH ActiveIneligibility cause. Possible value : ActiveLayerNotDeployed
siteTypeAllBuilding type. Possible values : PAVILLON ou IMMEUBLE
buildingManagerAllCompany name of building manager
buildingStatusAllbuilding state. Possible values CIBLE, RACCORDABLE DEMANDE, SIGNE, EN COURS DE DEPLOIEMENT, DEPLOYE et ABANDONNE
logementNumberAllNumber of appartments (residential or professionnal)
linkTypePBPTOAllPBPTO link type. Possible values (ex. AEOR for "AERIEN ORANGE"). Download the link type list of PBPTO
orderAcceptanceDateAllOrder acceptance date (format "AAAA-MM-JJ")
commercialLaunchDateAllCommercial launching date (format "AAAA-MM-JJ")
blockingReasonAllBlocking reason Download the list of blocking causes
unblockedDateAllPrevisional unblocking date (format "JJ/MM/AAAA")
oiCodeAllInfrastructure operator code PIN (ex: VENU, ATHD)
oiNameAllBoucle Locale Optique Mutualisée (ex : Vendée Numérique, Alliance Très Haut Débit)
pmCodeAllPM code(ex: FI-59221-000D)
nroCodeAllNRO code (ex: 59480QUE)

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: /productRIPQualification Method: POST

1. I want to check a site eligibility to FTTE offers from the following ND 01 23 45 67 89

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

I get :

{
    "code": 30,
    "message": "ND not found",
    "description": "The ND is not found."
}

2. I want to check a site eligibility to FTTE offers from a standardized address

{
  "contextType": "address",
  "category": {
    "name": "ftte"
  },
  "place": {
    "geographicAddress": {
    "rivoliCode": "0082",
    "cityCode": "53068",
    "streetNr": "59"
    }
  }
}

I get :

{
    "place": {
        "geographicSite": {
            "address": "59 CHEMIN DE LA MARE, 53400 CHERANCE",
            "normalizedAddress": {
                "inseeCode": "53068",
                "rivoliCode": "0082",
                "streetNr": "59",
                "streetNrSuffix": "",
                "streetType": "CHEMIN",
                "streetName": "DE LA MARE",
                "postcode": "53400",
                "city": "CHERANCE",
                "geographicSubAddress": [
                    {
                        "buildingCode": "IMB/53068/X/0052",
                        "geographicLocation": {
                            "longitude": -0.9485705070969273,
                            "latitude": 47.813891088641164,
                            "accuracy": "building"
                        }
                    }
                ]
            }
        }
    },
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "FTTE Passif",
            },
            "product": {
                "characteristics": [
                    {
                        "name": "nroCode",
                        "value": "53084XCR"
                    },
                    {
                        "name": "oiCode",
                        "value": "MAYE"
                    },
                    {
                        "name": "oiName",
                        "value": "Mayenne Fibre"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "partiallyDeployed",
            "productOffering": {
                "name": "FTTE Passif PM",
            },
            "product": {
                "characteristics": [
                    {
                        "name": "pmCode",
                        "value": "FI-53084-0002"
                    },
                    {
                        "name": "oiCode",
                        "value": "MAYE"
                    },
                    {
                        "name": "oiName",
                        "value": "Mayenne Fibre"
                    }
                ]
            }
        }
    ],
}

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

{
  "contextType": "address",
  "category": {
    "name": "ftte"
  },
  "place": {
    "geographicAddress": {
        "rivoliCode": "012R",
        "cityCode": "85020"
    }
  }
}

I get :

{
    "place": {
        "geographicSite": {
            "normalizedAddress": {
                "inseeCode": "85020",
                "rivoliCode": "012R",
                "streetNr": "0",
                "streetNrSuffix": "",
                "streetType": null,
                "postcode": null,
                "geographicSubAddress": [
                    {
                        "buildingName": "M1",
                        "buildingCode": "IMB/85020/X/000I",
                        "geographicLocation": {
                            "longitude": -0.577069805672707,
                            "latitude": 46.37015128478206
                        }
                    },
                    {
                        "buildingName": "M2",
                        "buildingCode": "IMB/85020/X/000J",
                        "geographicLocation": {
                            "longitude": -0.5778780066646744,
                            "latitude": 46.370427632662306
                        }
                    },
                    {
                        "buildingName": "M3",
                        "buildingCode": "IMB/85020/X/000K",
                        "geographicLocation": {
                            "longitude": -0.5781887929655724,
                            "latitude": 46.37064472824139
                        }
                    },
                    {
                        "buildingName": "M4",
                        "buildingCode": "IMB/85020/X/000L",
                        "geographicLocation": {
                            "longitude": -0.5785192115884559,
                            "latitude": 46.37001502349033
                        }
                    },
                    {
                        "buildingName": "M5",
                        "buildingCode": "IMB/85020/X/000M",
                        "geographicLocation": {
                            "longitude": -0.5786817666276524,
                            "latitude": 46.36965072159087
                        }
                    },
                    {
                        "buildingName": "M6",
                        "buildingCode": "IMB/85020/X/000N",
                        "geographicLocation": {
                            "longitude": -0.5774959712805582,
                            "latitude": 46.369609155977024
                        }
                    }
                ]
            }
        }
    },
    "qualificationResult": "notComputed",
    "productOfferingQualificationItem": [],
}

I want to check a site eligibility to FTTE offers by choosing one of the buildings :

{
    "contextType": "address",
    "category": {
        "name": "ftte"
    },
    "place": {
        "geographicAddress": {
            "rivoliCode": "012R",
            "cityCode": "85020",
            "geographicSubAddress": {
                "buildingCode": "IMB/85020/X/000I"
            }
        }
    }
}

I get:

{
    "place": {
        "geographicSite": {
            "normalizedAddress": {
                "inseeCode": "85020",
                "rivoliCode": "012R",
                "streetNr": "0",
                "streetNrSuffix": "",
                "streetType": null,
                "postcode": null,
                "geographicSubAddress": [
                    {
                        "buildingName": "M1",
                        "buildingCode": "IMB/85020/X/000I",
                        "geographicLocation": {
                            "longitude": -0.577069805672707,
                            "latitude": 46.37015128478206,
                            "accuracy": "building"
                        }
                    }
                ]
            }
        }
    },
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "deployed",
            "productOffering": {
                "name": "FTTE Passif",
            },
            "product": {
                "characteristics": [
                    {
                        "name": "nroCode",
                        "value": "85020BNW"
                    },
                    {
                        "name": "oiCode",
                        "value": "VENU"
                    },
                    {
                        "name": "oiName",
                        "value": "Vendée Numérique"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "notEligible",
            "qualificationItemReason": "notDeployed",
            "productOffering": {
                "name": "FTTE Passif PM",
            },
            "product": {
                "characteristics": [
                    {
                        "name": "oiCode",
                        "value": "VENU"
                    },
                    {
                        "name": "oiName",
                        "value": "Vendée Numérique"
                    }
                ]
            }
        }
    ],
}

4. I want to check a site eligibility to FTTE offers from GPS coordinates

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

Use case examples for FTTH 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 "ftth" instead of "ftte". For example : Resource: /productRIPQualification Method: POST

1. I want to check eligibility to FTTH offers from a textual address 59 CHEMIN DE LA MARE, 53400 CHERANCE

{
    "contextType": "fulltext",
    "category": {
        "name": "ftth"
    },
    "place": {
        "nonFormattedAddress": {
            "fullText": "59 CHEMIN DE LA MARE, 53400 CHERANCE"
        }
    }
}

I get :

{
    "place": {
        "geographicSite": {
            "address": "59 CHEMIN DE LA MARE, 53400 CHERANCE",
            "normalizedAddress": {
                "inseeCode": "53068",
                "rivoliCode": "0082",
                "streetNr": "59",
                "streetType": "CHEMIN",
                "streetName": "DE LA MARE",
                "postcode": "53400",
                "city": "CHERANCE",
                "geographicSubAddress": [
                    {
                        "buildingCode": "IMB/53068/X/0052",
                        "geographicLocation": {
                            "longitude": -0.9485705042736172,
                            "latitude": 47.81389107120403,
                            "accuracy": "building"
                        }
                    }
                ]
            }
        }
    },
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "marketable",
            "productOffering": {
                "name": "Accès aux lignes FTTH",
            },
            "product": {
                "characteristics": [
                    {
                        "name": "buildingStatus",
                        "value": "DEPLOYE"
                    },
                    {
                        "name": "orderAcceptanceDate",
                        "value": "2020-05-14"
                    },
                    {
                        "name": "commercialLaunchDate",
                        "value": "2020-05-29"
                    },
                    {
                        "name": "siteType",
                        "value": "PAVILLON"
                    },
                    {
                        "name": "logementNumber",
                        "value": "1"
                    },
                    {
                        "name": "linkTypePBPTO",
                        "value": "aéro-souterrain"
                    },
                    {
                        "name": "pmCode",
                        "value": "FI-53084-0002"
                    },
                    {
                        "name": "nroCode",
                        "value": "53084XCR"
                    },
                    {
                        "name": "oiCode",
                        "value": "MAYE"
                    },
                    {
                        "name": "oiName",
                        "value": "Mayenne Fibre"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "marketable",
            "productOffering": {
                "name": "FTTH activé",
            },
            "product": {
                "characteristics": [
                    {
                        "name": "buildingStatus",
                        "value": "DEPLOYE"
                    },
                    {
                        "name": "orderAcceptanceDate",
                        "value": "2020-05-14"
                    },
                    {
                        "name": "commercialLaunchDate",
                        "value": "2020-05-29"
                    },
                    {
                        "name": "siteType",
                        "value": "PAVILLON"
                    },
                    {
                        "name": "logementNumber",
                        "value": "1"
                    },
                    {
                        "name": "linkTypePBPTO",
                        "value": "aéro-souterrain"
                    },
                    {
                        "name": "pmCode",
                        "value": "FI-53084-0002"
                    },
                    {
                        "name": "nroCode",
                        "value": "53084XCR"
                    },
                    {
                        "name": "oiCode",
                        "value": "MAYE"
                    },
                    {
                        "name": "oiName",
                        "value": "Mayenne Fibre"
                    }
                ]
            }
        }
    ],
}

2. I want to check a site eligibility to FTTE offers from a building code

{
    "contextType": "buildingCode",
    "category": {
        "name": "ftth"
    },
    "publicKey": {
        "name": "buildingCode",       
        "value": "IMB/53068/X/0052"
    }
}

I get :

{
    "place": {
        "geographicSite": {
            "address": "59 CHEMIN DE LA MARE, 53400 CHERANCE",
            "normalizedAddress": {
                "inseeCode": "53068",
                "rivoliCode": "0082",
                "streetNr": "59",
                "streetType": "CHEMIN",
                "streetName": "DE LA MARE",
                "postcode": "53400",
                "city": "CHERANCE",
                "geographicSubAddress": [
                    {
                        "buildingCode": "IMB/53068/X/0052",
                        "geographicLocation": {
                            "longitude": -0.9485705042736172,
                            "latitude": 47.81389107120403,
                            "accuracy": "building"
                        }
                    }
                ]
            }
        }
    },
    "productOfferingQualificationItem": [
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "marketable",
            "productOffering": {
                "name": "Accès aux lignes FTTH",
            },
            "product": {
                "characteristics": [
                    {
                        "name": "buildingStatus",
                        "value": "DEPLOYE"
                    },
                    {
                        "name": "orderAcceptanceDate",
                        "value": "2020-05-14"
                    },
                    {
                        "name": "commercialLaunchDate",
                        "value": "2020-05-29"
                    },
                    {
                        "name": "siteType",
                        "value": "PAVILLON"
                    },
                    {
                        "name": "logementNumber",
                        "value": "1"
                    },
                    {
                        "name": "linkTypePBPTO",
                        "value": "aéro-souterrain"
                    },
                    {
                        "name": "pmCode",
                        "value": "FI-53084-0002"
                    },
                    {
                        "name": "nroCode",
                        "value": "53084XCR"
                    },
                    {
                        "name": "oiCode",
                        "value": "MAYE"
                    },
                    {
                        "name": "oiName",
                        "value": "Mayenne Fibre"
                    }
                ]
            }
        },
        {
            "qualificationItemResult": "eligible",
            "qualificationItemReason": "marketable",
            "productOffering": {
                "name": "FTTH activé",
            },
            "product": {
                "characteristics": [
                    {
                        "name": "buildingStatus",
                        "value": "DEPLOYE"
                    },
                    {
                        "name": "orderAcceptanceDate",
                        "value": "2020-05-14"
                    },
                    {
                        "name": "commercialLaunchDate",
                        "value": "2020-05-29"
                    },
                    {
                        "name": "siteType",
                        "value": "PAVILLON"
                    },
                    {
                        "name": "logementNumber",
                        "value": "1"
                    },
                    {
                        "name": "linkTypePBPTO",
                        "value": "aéro-souterrain"
                    },
                    {
                        "name": "pmCode",
                        "value": "FI-53084-0002"
                    },
                    {
                        "name": "nroCode",
                        "value": "53084XCR"
                    },
                    {
                        "name": "oiCode",
                        "value": "MAYE"
                    },
                    {
                        "name": "oiName",
                        "value": "Mayenne Fibre"
                    }
                ]
            }[enter link description here](/ope-contents/offers/TELItsCLGPyV2dah/products/LUHZllBvIB2KfUcT/contents/VjAGwh6JWnFvryfJ)
        }
    ],
}

Appendix

History of document

VersionModification dateDescription of changesAPIAPI version corresponding to this documentary version
v1.025/01/2021InitialisationRIP API Operator Eligibilityv1.0