Aller au contenu principal
Page non répertoriée
Cette page n'est pas répertoriée. Les moteurs de recherche ne l'indexeront pas, et seuls les utilisateurs ayant un lien direct peuvent y accéder.

Récupération d'un pays avec sa hiérarchie de localisation

Description​

Récupère le détail d’un pays à partir de son identifiant, avec sa hiérarchie complète : régions, départements et villes.


Endpoint​

GET https://api.mytalentplug.com/resources/v1/locations/countries/{id}

Authentification​

  • Requise : Oui
  • Type : Bearer Authentication
  • Exemple d’en-tête :
Authorization: Bearer <token>

Requête​

Paramètres de route​

Nom du paramètreTypeRequisFormatExempleDescription
idstringOuiref_...ref_xafslfwIdentifiant encodé du pays

Réponse​

La réponse est au format JSON.

Réponse 200 (succès)​

Exemple​
{
"id": "ref_xafslfw",
"name": "France",
"regions": [
{
"name": "Bourgogne",
"departments": [
{
"name": "89 - Yonne",
"cities": [
{
"id": "cty_mrsebq6",
"name": "Appoigny",
"zipcode": "89380",
"codeInsee": "89013"
}
]
}
]
}
]
}
Détail des champs

Propriétés de la réponse​

ChampTypeNullableDescription
idstringNonIdentifiant du pays.
namestringOuiNom du pays.
regionsarrayNonListe des régions du pays. Voir regions.

Schéma regions​

ChampTypeNullableDescription
namestringOuiNom de la région.
departmentsarrayNonListe des départements de la région. Voir departments.

Schéma departments​

ChampTypeNullableDescription
namestringOuiNom du département.
citiesarrayNonListe des villes du département. Voir cities.

Schéma cities​

ChampTypeNullableDescription
idstringNonIdentifiant de la ville.
namestringOuiNom de la ville.
zipcodestringOuiCode postal.
codeInseestringOuiCode INSEE de la commune.

Réponses d’erreur​

Code HTTPMessageDescription
400Bad RequestL’identifiant n’est pas un identifiant de pays valide
401UnauthorizedJeton d’accès manquant ou invalide
404Not FoundAucun pays trouvé pour l’identifiant fourni
500Internal Server ErrorLe serveur a rencontré un problème inattendu
Exemple​
{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"title": "Bad Request",
"status": 400,
"detail": "Validation failed: \n -- Id: must be a valid resource identifier Severity: Error"
}

Exemple de requête avec curl​

curl -X GET 'https://api.mytalentplug.com/resources/v1/locations/countries/ref_xafslfw' \
-H 'Authorization: Bearer <token>'