Écrire dans le RNB

Toute requête en écriture dans le RNB doit faire l’objet d’une authentification. Pour vous identifier, utilisez le token fourni par l’équipe du RNB. Pour faire une demande de token, renseignez ce formulaire.

Ajoutez une clé Authorization aux headers HTTP de chacune de vos requêtes. La valeur doit être votre token préfixé de la chaîne “Token”. Un espace sépare “Token” et votre token.

Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b

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

Ce endpoint nécessite d'être identifié et d'avoir les droits d'écrire dans le RNB. Il permet de : mettre à jour un bâtiment existant (status, addresses_cle_interop, shape) de désactiver son RNB ID (is_active) s'il s'avère qu'il ne devrait pas faire partir du RNB. Par exemple un arbre qui aurait été par erreur repertorié comme un bâtiment du RNB. de réactiver un RNB ID, 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. 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"]}

PATCHhttps://rnb-api.beta.gouv.fr/api/alpha/buildings/{rnb_id}/

Path parameters

rnb_id*string

Identifiant unique du bâtiment dans le RNB

Example: "PG46YY6YWCX8"

Body

application/json

commentstring

Texte associé à la modification et la justifiant. Exemple : "Ce n'est pas un bâtiment mais un arbre."

is_activeboolean

False : le RNB ID 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 : le RNB ID est réactivé. À utiliser uniquement pour annuler une désactivation accidentelle.

statusstring

Mise à jour du statut du bâtiment. Les valeurs possibles sont : constructionProject : En projetcanceledConstructionProject : Projet annuléongoingConstruction : Construction en coursconstructed : ConstruitongoingChange : En cours de modificationnotUsable : Non utilisabledemolished : Démoli

addresses_cle_interoplist

Liste des clés d'interopérabilité BAN liées au bâtiments. Si ce paramêtre est absent, les clés ne sont pas modifiées. Si le paramêtre est présent et que sa valeur est une liste vide, le bâtiment ne sera plus lié à une adresse. Exemple: ["75105_8884_00004", "75105_8884_00006"]

shapestring

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.

Response

204

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://rnb-api.beta.gouv.fr/api/alpha/buildings/{rnb_id}/', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

D'autres endpoints d'écriture sont prévus et seront ajoutés au fur et à mesure de l'avancée du projet. Il sera prochainement possible (début 2025) de créer, fusionner et scinder des bâtiments dans le RNB.