REST Resource: resources.buildings

Zasób: Budynek

Publiczny interfejs API: Resources.buildings

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

string

Unikalny identyfikator budynku. Maksymalna długość to 100 znaków.

buildingName

string

Nazwa budynku widoczna dla użytkowników w Kalendarzu. Musi być unikalny dla danego klienta. Na przykład „NYC-CHEL”. Maksymalna długość to 100 znaków.

description

string

Krótki opis budynku. Na przykład „Chelsea Market”.

coordinates

object (BuildingCoordinates)

współrzędne geograficzne środka budynku wyrażone jako szerokość i długość geograficzna w stopniach dziesiętnych;

kind

string

Rodzaj zasobu.

etags

string

ETag zasobu.

floorNames[]

string

Wyświetlane nazwy wszystkich pięter w tym budynku. Piętra powinny być posortowane w kolejności rosnącej, od najniższego do najwyższego. Na przykład ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Musi zawierać co najmniej 1 wartość.

address

object (BuildingAddress)

Adres pocztowy budynku. Więcej informacji: PostalAddress. Pamiętaj, że wymagany jest tylko 1 wiersz adresu i kod regionu.

BuildingCoordinates

Publiczny interfejs API: Resources.buildings

Zapis JSON
{
  "latitude": number,
  "longitude": number
}
Pola
latitude

number

Szerokość geograficzna w stopniach dziesiętnych.

longitude

number

Długość geograficzna w stopniach dziesiętnych.

BuildingAddress

Publiczny interfejs API: Resources.buildings

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

string

Wymagane. Kod regionu CLDR kraju/regionu adresu.

languageCode

string

Opcjonalnie: Kod języka BCP-47 treści tego adresu (jeśli jest znany).

postalCode

string

Opcjonalnie: Kod pocztowy w adresie.

administrativeArea

string

Opcjonalnie: Najwyższy podział administracyjny, który jest używany w przypadku adresów pocztowych w kraju lub regionie.

locality

string

Opcjonalnie: Zwykle odnosi się do części adresu zawierającej nazwę miasta. Przykłady: miasto w USA, miasto w Włoszech, miejscowość w Wielkiej Brytanii. W regionach świata, w których miejscowości nie są dobrze zdefiniowane lub nie pasują do tej struktury, pozostaw pole „Locality” puste i użyj atrybutów „addressLines”.

sublocality

string

Opcjonalnie: Podjednostka adresu.

addressLines[]

string

Nieuporządkowane wiersze adresu opisujące niższe poziomy adresu.

Metody

delete

Usuwa budynek.

get

Pobiera dane budynku.

insert

Wstawia budynek.

list

Pobiera listę budynków na koncie.

patch

Naprawia budynek.

update

Zaktualizuj budynek.