REST Resource: resources.buildings

Zasób: Tworzenie

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ć niepowtarzalna dla klienta. Na przykład: „NYC-CHEL”. Maksymalna długość to 100 znaków.

description

string

Krótki opis budynku. na przykład „Rynkowa Rynek”.

coordinates

object (BuildingCoordinates)

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

kind

string

To pewnego rodzaju zasób.

etags

string

ETag zasobu.

floorNames[]

string

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

address

object (BuildingAddress)

Adres pocztowy budynku. Więcej informacji znajdziesz na stronie PostalAddress. Wymagany jest tylko jeden 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

To pole jest wymagane. Kod regionu CLDR kraju lub regionu adresu.

languageCode

string

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

postalCode

string

Opcjonalnie. Kod pocztowy adresu.

administrativeArea

string

Opcjonalnie. Najwyższy podział administracyjny używany w przypadku adresów pocztowych w kraju lub regionie.

locality

string

Opcjonalnie. Zwykle odnosi się do miasta/miasta adresu. Przykłady: miasto w USA, gmina IT, brytyjska poczta. W regionach świata, gdzie miejscowości nie są dobrze zdefiniowane lub nie mieszczą się w tej strukturze, pozostaw pole rejonu puste i użyj pola addressLines.

sublocality

string

Opcjonalnie. Dzielnica adresu.

addressLines[]

string

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

Metody

delete

usuwa budynek.

get

Pobiera budynek.

insert

Wstawia budynek.

list

Pobiera listę budynków z konta.

patch

Poprawia budynek.

update

Aktualizuje budynek.