...
La structure pour construire une requête REST est une URL : {host_url}/{service}/{version}/{response_type}/{datasetCode}?{format}&{lang}&{filters}
Partie URL | Exemple | Commentaire |
|---|---|---|
Partie fixe (fixed part) | ||
{host_url}/ | Partie fixe de la requête (site web) | |
{service}/ | statistics/ | Partie fixe de la requête qui indique le service |
{version}/ | 1.0/ | Partie fixe de la requête qui indique la version |
Partie dynamique (dynamic part) | ||
{response_type}/ | data/ | Seules les données statistiques sont actuellement retournées |
{datasetCode} | t2020_10 | Code unique qui identifie les données recherchée (soit un set de données ou une extraction prédéfinie) |
?{format} | ?format=JSON | Paramètre optionel |
&{lang} | &lang=FR | Paramètre optionel |
&{filters} | &time=2019 | Paramètres optionels |
Les paramètres définis dans la requête REST
...
Messages d’erreur envoyé en cas de requêtes invalides
Code Erreur | Status HTTP | Description |
|---|---|---|
Erreur client | ||
100 Pas de résultats | 400 Requête incorrecte | Les résultats de la requête est vide. |
100 Pas de résultats | 404 Non trouvé | La ressource demandée n’est pas disponible. |
110 Non autorisé | 401 Non autorisé | Utilisé quand l’authentification est nécessaire mais ayant échouée ou n’ayant pas encore été fournie. Les erreurs ECAS peuvent être :
|
140 Erreur de syntaxe | 400 Requête incorrecte | La requête est invalide. |
140 Erreur de syntaxe | 404 Non trouvé | La ressource demandée ne fait pas partie des méthodes supportées. Ressources non supportées :
|
150 Erreur de sémantique | 400 Requête incorrecte | La requête est correcte au niveau syntaxique mais échoue à cause d’une validation sémantique ou un règle métier. |
Erreur serveur | ||
500 Erreur interne du serveur | 401 Non autorisé | La ressource demandée existe mais n’est pas disponible pour le moment. |
500 Erreur interne du serveur | 500 Erreur interne du serveur | Le service web devrait renvoyer cette erreur quand aucun autre code d’erreur est capable de mieux décrire la cause de l’échec du service à fournir une réponse correcte. Également utilise dans le cas où la requête ne respecte pas la définition du XSD. |
Réponse asynchrone dans le cas de grandes extractions
...