Feature Request: Standardize Administrative Levels and expose INSEE code (citycode)

[wikub]

Currently, the Addok provider returns a flat structure in the Address object metadata, but the AdminLevelCollection is not fully utilized to represent the French administrative hierarchy (Region, Department, Municipality). And currently, the INSEE code is not in the extra data either, even though it is provided by the BAN API.

I would like to propose an evolution of the AddokProvider to map the French administrative data (from the context field in Addok API) to standard AdminLevel objects:

• Level 1: Country (France)
• Level 2: Region (e.g., "Pays de la Loire")
• Level 3: Department (Name and Code, e.g., "Vendé" / "85")
• Level 4: Municipality (Name and INSEE Code as the Level code, e.g., "28236")
• Level 5 : District / Arrondisement (Name of the district, e.g., "Paris 16e Arrondissement")

I am willing to submit a Pull Request for this! As this would be my first contribution, I would appreciate a confirmation on the preferred mapping for these levels to ensure it matches the project's vision.

Do you agree with the Level 2 (Region), Level 3 (Department), Level 4 (Municipality/INSEE), Level 5 (District/Arrondissement) hierarchy?
Please tell me how we can move forward on this issue and how I can help.

Thank you.

[wikub]

I have already prepared a branch : https://github.com/wikub/geocoder-php-addok-provider/tree/add-admin-levels

[jbelien]

Definitely feel free to open a PR here! 👍
Order of AdminLevel in Geocoder PHP is poorly documented because each provider handles it differently and there is no real standard about it ; see geocoder-php/Geocoder#852