| Scroll Ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
Concept
Les Paramètres
Méthode GET permettant de récupérer la structure d'une vue météo.
La structure retournée est la même que celle visible dans l'onglet "JSON" du mode édition d'une vue météo dans l'Interface de Visualisation ( voir la page Édition JSON - Météo ).
Les paramètres
Le paramètre ID reçu dans l'URL identifie la vue météo à rechercher.
Réponse
Codes de retour
Réponse| Codes de retour | Explications |
|---|---|
| 200 | OK |
| 400 | Paramètre invalide |
| 401 | L'accès nécessite une authentification ou un Token valide. |
| 403 | Authentification de l'utilisateur OK, mais droits non suffisants. |
| 404 | La vue météo n'existe pas. |
| 500 | L'appel est valide, mais un problème d'exécution est rencontré. |
Retour du code 200
Retour du code 400
Paramètres POST incorrects
Paramètre inconnu
Messages d'erreurs des filtres
Erreurs communes lors de l'envoi de la requête
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -s -S -U 'username:password' \
"http://webui:7767/external-api/service-weather/v1/get/WEATHER_UUID" |
Exemple de sortie attendue :
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"critical": [],
"errors": [],
"warnings": [],
"output": {
"view_info": {
"name": "Bordeaux",
"state": "draft",
"type": "service_weather",
"weather_uuid": "ab512c70e84a4c7a9b0e23b46eec5355",
"weather_version": 2,
"weather_format_version": 5,
"weather_shared_group": "service_weather",
"weather_creation_time": 1787666586.1508853
},
"view_json": {
...
}
}
} |
| Info |
|---|
Dans view_json se trouve le contenu de la vue météo. |
Messages de validation
| Excerpt Include | ||||||
|---|---|---|---|---|---|---|
|
Retour du code 404
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -s -S -U 'username:password' \
"http://webui:7767/external-api/service-weather/v1/get/unknown_uuid" |
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"output": "Weather with uuid [ unknown_uuid ] was not found"
} |
| Excerpt Include | ||
|---|---|---|
|
- Mêmes erreurs que dans l'interface ( dans la langue de l'interface )
- Même comportement que l'interface : On peut sauvegarder la vue si l'interface l'aurait autorisé.
- Code d'erreur HTTP cohérent
| Excerpt Include | |||||
|---|---|---|---|---|---|
|