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ètre | Type | Requis | Format | Exemple | Description |
|---|---|---|---|---|---|
id | string | Oui | ref_... | ref_xafslfw | Identifiant 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
| Champ | Type | Nullable | Description |
|---|---|---|---|
id | string | Non | Identifiant du pays. |
name | string | Oui | Nom du pays. |
regions | array | Non | Liste des régions du pays. Voir regions. |
Schéma regions
| Champ | Type | Nullable | Description |
|---|---|---|---|
name | string | Oui | Nom de la région. |
departments | array | Non | Liste des départements de la région. Voir departments. |
Schéma departments
| Champ | Type | Nullable | Description |
|---|---|---|---|
name | string | Oui | Nom du département. |
cities | array | Non | Liste des villes du département. Voir cities. |
Schéma cities
| Champ | Type | Nullable | Description |
|---|---|---|---|
id | string | Non | Identifiant de la ville. |
name | string | Oui | Nom de la ville. |
zipcode | string | Oui | Code postal. |
codeInsee | string | Oui | Code INSEE de la commune. |
Réponses d’erreur
| Code HTTP | Message | Description |
|---|---|---|
400 | Bad Request | L’identifiant n’est pas un identifiant de pays valide |
401 | Unauthorized | Jeton d’accès manquant ou invalide |
404 | Not Found | Aucun pays trouvé pour l’identifiant fourni |
500 | Internal Server Error | Le 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>'