Entonnoir d'adresse

Avertissement

Cette version de l'API d'éligibilité est dépréciée et sera prochainement désactivée. Elle ne doit en aucun cas être utilisée pour de nouveaux développements. Vous êtes invités à migrer vers l'API d'éligibilité v2.

Rechercher un code INSEE

La recherche d'endpoint à l'adresse nécessite de fournir un code INSEE identifiant la commune. Il est possible de retrouver ce code en effectuant une recherche par code postal en faisant un GET sur l'url /api/eligibility/zipcodes/{zipcode}/

Réponse

Le résultat de l'appel est un dictionnaire contenant une clef cities. La valeur de cette clef est une liste de localités et leurs insee_code et zipcode.

Nom du champ	Type	Description
name	string	Nom de la localité
insee_code	string	Code INSEE de la localité
zipcode	string	Code postal de la localité

Exemple

GET /api/eligibility/zipcodes/06130/ HTTP/1.1
Host: extranet.kosc-telecom.fr

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

{
    "cities": [
        {
            "insee_code": "06069",
            "name": "GRASSE",
            "zipcode": "06130"
        },
        {
            "insee_code": "06069",
            "name": "PLAN DE GRASSE",
            "zipcode": "06130"
        },
        {
            "insee_code": "06069",
            "name": "PLASCASSIER",
            "zipcode": "06130"
        }
    ]
}

Rechercher un code RIVOLI

La recherche d'endpoint à l'adresse nécéssite de fournir un code RIVOLI identifiant la voie. Pour retrouver le rivoli_code d'une rue ainsi que les numéros sur cette rue, il faut faire un GET sur l'url /api/eligibility/streets/{insee_code}/.

Réponse

Le résultat de l'appel est un dictionnaire contenant une clef streets. La valeur de cette clef représente une liste de rues composées des champs suivants:

Nom du champ	Type	Description
street_name	string	Le nom de la rue tel qu'il faudra le fournir aux APIs d'éligibilité et de commande
rivoli_code	string	Code RIVOLI de la rue

Exemple

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

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

{
    "streets": [
        {
            "street_name": "ACHE ST CHRISTOPHE",
            "rivoli_code": "0094"
        },
        {
            "street_name": "ACHE ST JEAN",
            "rivoli_code": "0095"
        },

        {
            "street_name": "CHE BLUMENTHAL",
            "rivoli_code": "0460"
        }
    ]
}

Rechercher un numéro de rue

Il est possible de lister les numéros d'une rue en faisant un GET sur l'url /api/eligibility/numbers/{insee_code}/.

Paramètres

Pour préciser la rue qui vous intéresse, un des deux paramètres suivants doit être fournis dans la requête.

Nom du paramètre	Description
street_name	Le nom de la rue tel qu'il a été fourni par l'api streets
rivoli_code	Le code rivoli de la rue

Réponse

Le résultat de l'appel est un dictionnaire contenant une clef numbers. La valeur de cette clef est une liste de dictionnaires contenant les numéros disponibles dans cette rue.

Exemple

GET /api/eligibility/numbers/06069/?rivoli_code=0490 HTTP/1.1
Host: extranet.kosc-telecom.fr

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

{
    "numbers": [
        {
            "number": "7"
        },
        {
            "number": "11"
        },
        {
            "number": "13"
        }
    ]
}