REST Resource: resources.buildings

Ressource: Bâtiment

API publique: Resources.buildings

Représentation JSON 
{
  "buildingId": string,
  "buildingName": string,
  "description": string,
  "coordinates": {
    object (BuildingCoordinates)
  },
  "kind": string,
  "etags": string,
  "floorNames": [
    string
  ],
  "address": {
    object (BuildingAddress)
  }
}
Champs
buildingId

string

Identifiant unique du bâtiment. La longueur ne doit pas dépasser 100 caractères.
buildingName

string

Nom du bâtiment tel qu'il est vu par les utilisateurs dans Agenda. Doit être unique pour le client. Exemple : "NYC-CHEL". La longueur ne doit pas dépasser 100 caractères.
description

string

Brève description du bâtiment. Exemple : "Chelsea Market".
coordinates

object (BuildingCoordinates)

Coordonnées géographiques du centre du bâtiment, exprimées en latitude et en longitude en degrés décimaux.
kind

string

Type de ressource dont il s'agit.
etags

string

ETag de la ressource.
floorNames[]

string

Noms à afficher pour tous les étages de ce bâtiment. Les étages doivent être triés par ordre croissant, du plus bas au plus haut. Par exemple, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Doit contenir au moins une entrée.
address

object (BuildingAddress)

Adresse postale du bâtiment. Pour en savoir plus, consultez PostalAddress. Notez qu'une seule ligne d'adresse et un seul code de région sont requis.

BuildingCoordinates

API publique: Resources.buildings

Représentation JSON 
{
  "latitude": number,
  "longitude": number
}
Champs
latitude

number

Latitude en degrés décimaux.
longitude

number

Longitude en degrés décimaux.

BuildingAddress

API publique: Resources.buildings

Représentation JSON 
{
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ]
}
Champs
regionCode

string

Obligatoire. Code pays/région CLDR de l'adresse.
languageCode

string

Facultatif. Code de langue BCP-47 du contenu de cette adresse (s'il est connu).
postalCode

string

Facultatif. Code postal de l'adresse.
administrativeArea

string

Facultatif. Plus haute subdivision administrative utilisée pour les adresses postales d'un pays ou d'une région.
locality

string

Facultatif. Fait généralement référence à la ville de l'adresse. Exemples : une "city" aux États-Unis, une "comune" en Italie, une "post town" au Royaume-Uni. Dans les régions du monde où les localités ne sont pas bien définies ou ne s'intègrent pas bien dans cette structure, laissez le champ de localité vide et utilisez addressLines.
sublocality

string

Facultatif. Sous-localité de l'adresse.
addressLines[]

string

Lignes d'adresse non structurées décrivant les niveaux inférieurs d'une adresse.

Méthodes

delete

 Supprime un bâtiment.

get

 Récupère un bâtiment.

insert

 Insère un bâtiment.

list

 Récupère la liste des bâtiments d'un compte.

patch

 Applique un correctif à un bâtiment.

update

 Met à jour un bâtiment.