Entonnoir d'adresse

Lister les communes (kosc_insee_code) d'un code postal

Pour lister les différents codes INSEE Covage identifiant la commune, vous devez procéder à une recherche par code postal via un GET sur l'url /api/v2/eligibility/cities/.

Paramètres

Nom du paramètre	Présence	Type	Contrainte	Description
zipcode	Obligatoire	string	5 chars number	Code postal de l'adresse recherchée

Réponse

Le résultat de l'appel est une liste de dictionnaire city (commune).

Nom du champ	Type	Description
kosc_insee_code	string	Code INSEE Covage de la commune
city	string	Nom de la commune
locality	string	Nom de la localité
zipcode	string	Code postal de la localité

Exemple

GET /api/v2/eligibility/cities/?zipcode=06130 HTTP/1.1
Host: extranet.kosc-telecom.fr

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

[
    {
        "kosc_insee_code": "06069",
        "locality": "GRASSE",
        "zipcode": "06130",
        "city": "GRASSE"
    },
    {
        "kosc_insee_code": "06069",
        "locality": "LE PLAN DE GRASSE",
        "zipcode": "06130",
        "city": "GRASSE"
    },
    {
        "kosc_insee_code": "06069",
        "locality": "PLASCASSIER",
        "zipcode": "06130",
        "city": "GRASSE"
    }
]

Erreurs

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

Lister les rues (kosc_street_code) d'une commune à partir de son kosc_insee_code

La recherche à l'adresse d'endpoint ou de building nécessite de fournir un kosc_street_code identifiant la voie. Pour le récupérer, vous devez procéder à un GET sur l'url /api/v2/eligibility/streets/ à partir du kosc_insee_code.

Paramètres

Nom du paramètre	Présence	Type	Contrainte	Description
kosc_insee_code	Obligatoire	string	5 chars number	Code INSEE Covage

Réponse

Le résultat de l'appel est une liste de dictionnaire street.

Nom du champ	Type	Description
street_name	string	Nom de la rue
kosc_street_code	string	Identifiant Covage de la voie

Exemple

GET /api/v2/eligibility/streets/?kosc_insee_code=06069 HTTP/1.1
Host: extranet.kosc-telecom.fr

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

[
    {
        "street_name": "ALLEE AGAPANTHES  DOM OISEAUX",
        "kosc_street_code": "06069012M2"
    },
    {
        "street_name": "ALLEE AGATHEES  DOM OISEAUX",
        "kosc_street_code": "06069007M2"
    },
    {
        "street_name": "ALLEE ALTHEAS  DOM OISEAUX",
        "kosc_street_code": "06069003M2"
    },
]

Erreurs

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

Lister les numéros d'une rue à partir de son kosc_street_code

Il est possible de lister les numéros d'une rue via un GET sur l'url /api/v2/eligibility/street_numbers/.

Paramètres

Nom du paramètre	Présence	Type	Contrainte	Description
kosc_street_code	Obligatoire	string	Max 11 chars	Identifiant Covage de la voie

Réponse

Le résultat de l'appel est une liste des numéros de la rue.

Exemple

GET /api/v2/eligibility/street_numbers/?kosc_street_code=06069012M1 HTTP/1.1
Host: extranet.kosc-telecom.fr

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

[
    "47", "48", "49", "50", "51", "52", "53", "54", "55", "56", "57", "58", "59"
]

Erreurs

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

Lister les adresses proches d'un point géographique (longitude, latitude)

Vous pouvez lister les adresses via un GET sur l'url /api/v2/eligibility/coordinates/.

Paramètres

Nom du paramètre	Présence	Type	Contrainte	Description
lon	Obligatoire	Decimal	-180 <= valeur <= 180	Longitude (+ à l'est, - à l'ouest). La valeur doit être en France continentale ou en Corse
lat	Obligatoire	Decimal	-90 <= valeur <= 90	Latitude. La valeur doit être en France continentale ou en Corse
dist	Facultatif	integer	5 <= valeur <= 999	Distance en mètres. Si non précisée, la valeur par défaut est égale à 10

Réponse

Le résultat de l'appel est une liste de dictionnaire.

Exemple

GET /api/v2/eligibility/coordinates/?lon=2.12&lat=48.56&dist=150 HTTP/1.1
Host: extranet.kosc-telecom.fr

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

[
    {
        'locality': 'VILLEMOMBLE',
        'zipcode': '93250',
        'street_number': '8',
        'street_name': 'ALLEE DE L ESPERANCE',
        'kosc_street_code': '9307731850',
        'distance': 123,
        'lon_result': '2.1212',
        'lat_result': '48.5578'
        'lon_source': '2.12',
        'lat_source': '48.56',
        'kosc_insee_code': '93077'
    },
]

Erreurs

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