REST Resource: resources.buildings

Risorsa: edificio

API pubblica: Resources.buildings

Rappresentazione JSON
{
  "buildingId": string,
  "buildingName": string,
  "description": string,
  "coordinates": {
    object (BuildingCoordinates)
  },
  "kind": string,
  "etags": string,
  "floorNames": [
    string
  ],
  "address": {
    object (BuildingAddress)
  }
}
Campi
buildingId

string

Identificatore univoco dell'edificio. La lunghezza massima è di 100 caratteri.

buildingName

string

Il nome dell'edificio così come viene visto dagli utenti in Calendar. Deve essere univoco per il cliente. Ad esempio, "NYC-CHEL". La lunghezza massima è di 100 caratteri.

description

string

Una breve descrizione dell'edificio. Ad esempio, "Chelsea Market".

coordinates

object (BuildingCoordinates)

Le coordinate geografiche del centro dell'edificio, espresse come latitudine e longitudine in gradi decimali.

kind

string

Il tipo di risorsa.

etags

string

ETag della risorsa.

floorNames[]

string

I nomi visualizzati per tutti i piani dell'edificio. I piani dovrebbero essere elencati in ordine crescente, dal più basso al più alto. Ad esempio, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"]. Deve contenere almeno una voce.

address

object (BuildingAddress)

L'indirizzo postale dell'edificio. Per ulteriori dettagli, consulta PostalAddress. Tieni presente che sono obbligatori un'unica riga indirizzo e un prefisso.

BuildingCoordinates

API pubblica: Resources.buildings

Rappresentazione JSON
{
  "latitude": number,
  "longitude": number
}
Campi
latitude

number

Latitudine in gradi decimali.

longitude

number

Longitudine in gradi decimali.

BuildingAddress

API pubblica: Resources.buildings

Rappresentazione JSON
{
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ]
}
Campi
regionCode

string

Obbligatorio. Codice regione CLDR del paese/della regione dell'indirizzo.

languageCode

string

(Facoltativo) Codice lingua BCP-47 dei contenuti dell'indirizzo (se noto).

postalCode

string

(Facoltativo) Il codice postale dell'indirizzo.

administrativeArea

string

(Facoltativo) Suddivisione amministrativa di livello più elevato utilizzata per gli indirizzi postali di un paese o di una regione.

locality

string

(Facoltativo) In genere si riferisce alla porzione di città dell'indirizzo. Esempi: "city" per gli Stati Uniti, "comune" in Italia, "post town" nel Regno Unito. Lì dove le località non sono ben definite o non rientrano nella struttura, lascia il campo vuoto e usa addressLines.

sublocality

string

(Facoltativo) Quartiere dell'indirizzo.

addressLines[]

string

Righe di indirizzo non strutturate che descrivono i livelli inferiori di un indirizzo.

Metodi

delete

Elimina un edificio.

get

Recupera un edificio.

insert

Inserisce un edificio.

list

Recupera un elenco di edifici per un account.

patch

Applica patch a un edificio.

update

Aggiorna un edificio.