Forecast

Get a forecast for the FTTH eligibility from an address

This API deliver a forecast for the FTTH eligibility when no building is known at the address. This call is supposed to come right after an empty response from v2/eligibility/buildings/?kosc_street_code=X&street_number=Y&street_extension=Z with the same parameters.

To get a forecast from an address, make a GET request to the URL /api/v2/eligibility/forecast_eligibility/.

Parameters

Name of the parameter	Presence	Type	Constraint	Description
kosc_street_code	Mandatory	string	Max 11 chars	Kosc Street ID (to retrieve here)
street_number	Mandatory	string	Max 7 chars	Street number (to retrieve here)

Response

The result of the call is a dictionary.

Example

GET /api/v2/eligibility/buildings/?street_number=5b&kosc_street_code=130816920 HTTP/1.1
Host: extranet.kosc-telecom.fr

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

   {
       "address": {
           "street_number": "5B",
           "street_name": "AVENUE DE LA PLANTADE",
           "kosc_street_code": "130816920",
           "kosc_insee_code": "13081",
           "city": "ROGNAC"
       },
       "message_elig_code": "FIBER_NOT_YET_DEPLOYED",
       "message_elig_text_fr": "Votre Quartier sera commercialisable chez Covage à partir de",
       "message_elig_text_en": "Votre Quartier sera commercialisable chez Covage à partir de",
       "message_elig_date": "2023"
   }

Errors

HTTP code	Message
400	Invalid input
500	Unable to serve your request