REST Resource: resources.buildings

Recurso: Building

API pública: Resources.buildings

Representação JSON
{
  "buildingId": string,
  "buildingName": string,
  "description": string,
  "coordinates": {
    object (BuildingCoordinates)
  },
  "kind": string,
  "etags": string,
  "floorNames": [
    string
  ],
  "address": {
    object (BuildingAddress)
  }
}
Campos
buildingId

string

Identificador exclusivo do edifício. O comprimento máximo é de 100 caracteres.

buildingName

string

O nome do edifício que aparece para os usuários no app Agenda. Precisa ser exclusivo para o cliente. Por exemplo, "NYC-CHEL". O comprimento máximo é de 100 caracteres.

description

string

Uma breve descrição do edifício. Por exemplo, "Chelsea Market".

coordinates

object (BuildingCoordinates)

As coordenadas geográficas do centro do edifício, expressas como latitude e longitude em graus decimais.

kind

string

Tipo de recurso em questão.

etags

string

ETag do recurso.

floorNames[]

string

Os nomes de exibição de todos os andares do edifício. Os andares precisam ser classificados em ordem crescente, do andar mais baixo ao mais alto. Por exemplo, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Precisa conter pelo menos uma entrada.

address

object (BuildingAddress)

O endereço postal do edifício. Consulte PostalAddress para ver detalhes. Apenas uma linha de endereço e um código de região são necessários.

BuildingCoordinates

API pública: Resources.buildings

Representação JSON
{
  "latitude": number,
  "longitude": number
}
Campos
latitude

number

Latitude em graus decimais.

longitude

number

Longitude em graus decimais.

BuildingAddress

API pública: Resources.buildings

Representação JSON
{
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ]
}
Campos
regionCode

string

Obrigatório. Código de região CLDR do país/região do endereço.

languageCode

string

Opcional. Código de idioma BCP-47 do conteúdo deste endereço (se conhecido).

postalCode

string

Opcional. Código postal do endereço.

administrativeArea

string

Opcional. A maior subdivisão administrativa que é usada para endereços postais de um país ou uma região.

locality

string

Opcional. Geralmente se refere à parte do endereço relativa a cidade/município. Exemplos: cidade nos EUA, comunidade na Itália, distrito postal no Reino Unido. Em regiões onde as localidades não são claramente definidas ou não se encaixam bem nessa estrutura, deixe a localidade em branco e use addressLines.

sublocality

string

Opcional. Sublocalidade do endereço.

addressLines[]

string

Linhas de endereço não estruturadas que descrevem os níveis mais baixos de um endereço.

Métodos

delete

Exclui uma construção.

get

Recupera uma construção.

insert

Insere uma construção.

list

Recupera uma lista de edifícios de uma conta.

patch

Aplica patch em um edifício.

update

Atualiza uma construção.