| 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 |
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é. |
- Retourne le JSON de la météo
/create
- La météo peut avoir le nom d'une météo déjà existante
- L'API retourne l'UUID de la vue
- Création d'une vue uniquement : Pas de contenu à la création
/update/<uuid>
- Renvoi du JSON complet
- Explication sur la mise à jour d'un élément dans un Widget Météo
- Renseigner UUID et/ou nom.
/delete/<uuid>
- Envoie dans la corbeille.
/publish/<uuid>
- Publie une météo en construction
Messages d'erreurs
Retour du code 200
| 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 | ||||||
|---|---|---|---|---|---|---|
|