Page

Mise à jour ou désactivation/réactivation d'un bâtiment

patch

Cet endpoint permet de :

• mettre à jour un bâtiment existant (status, addresses_cle_interop, shape)
• désactiver son ID-RNB s'il s'avère qu'il ne devrait pas faire partie du RNB. Par exemple un arbre qui aurait été par erreur répertorié comme un bâtiment du RNB.
• réactiver un ID-RNB, si celui-ci a été désactivé par erreur.

Il n'est pas possible de simultanément mettre à jour un bâtiment et de le désactiver/réactiver.

Cet endpoint nécessite d'être identifié et d'avoir des droits d'édition du RNB.

Exemples valides:

• {"comment": "faux bâtiment", "is_active": False}
• {"comment": "RNB ID désactivé par erreur, on le réactive", "is_active": True}
• {"comment": "bâtiment démoli", "status": "demolished"}
• {"comment": "bâtiment en ruine", "status": "notUsable", "addresses_cle_interop": ["75105_8884_00004"]}

Paramètres de chemin

rnb_idstringRequis

Identifiant unique du bâtiment dans le RNB (ID-RNB)

Example: PG46YY6YWCX8

Corps

commentstringOptionnel

Texte associé à la modification et la justifiant.

is_activebooleanOptionnel

• False : l' ID-RNB est désactivé, car sa présence dans le RNB est une erreur. Ne permet pas de signaler une démolition, qui doit se faire par une mise à jour du statut.
• True : l'ID-RNB est réactivé. À utiliser uniquement pour annuler une désactivation accidentelle.

statusstring · enumOptionnel

Statut du bâtiment.

Valeurs possibles:

addresses_cle_interoparrayOptionnel

Liste des clés d'interopérabilité BAN liées au bâtiment.

Si ce paramêtre est :

• absent, alors les clés ne sont pas modifiées.
• présent et que sa valeur est une liste vide, alors le bâtiment ne sera plus lié à aucune adresse.

shapestringOptionnel

Géométrie du bâtiment au format WKT ou HEX. La géometrie attendue est idéalement un polygone représentant le bâtiment, mais il est également possible de ne donner qu'un point.

Réponses

204

Pas de contenu attendu dans la réponse en cas de succès

400

Requête invalide (données mal formatées ou incomplètes).

403

L'utilisateur n'a pas les droits nécessaires pour créer un bâtiment.

404

ID-RNB inconnu ou une clé d'interopérabilité n'a pas été trouvée auprès de la BAN

429

Le quota de requêtes a été atteint. Un quota maximal de 20 requêtes par secondes est appliqué, mais celui-ci peut varier par requête. Veuillez consulter les headers HTTP de la réponse pour plus d'informations concernant le quota.

503

Service temporairement indisponible

patch

HTTPcURLJavaScriptPython

PATCH /api/alpha/buildings/{rnb_id}/ HTTP/1.1
Host: localhost:8000
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "comment": "text",
  "is_active": true,
  "status": "constructionProject",
  "addresses_cle_interop": [],
  "shape": "text"
}

Aucun contenu