REST Resource: resources.buildings

Recurso: Building

API pública: Resources.buildings

Representación JSON
{
  "buildingId": string,
  "buildingName": string,
  "description": string,
  "coordinates": {
    object (BuildingCoordinates)
  },
  "kind": string,
  "etags": string,
  "floorNames": [
    string
  ],
  "address": {
    object (BuildingAddress)
  }
}
Campos
buildingId

string

Es el identificador único del edificio. La longitud máxima es de 100 caracteres.

buildingName

string

El nombre del edificio tal como lo ven los usuarios en Calendario. Debe ser único para el cliente. Por ejemplo, “NYC-CHEL”. La longitud máxima es de 100 caracteres.

description

string

Una breve descripción del edificio. Por ejemplo, “Chelsea Market”.

coordinates

object (BuildingCoordinates)

Coordenadas geográficas del centro del edificio, expresadas como latitud y longitud en grados decimales.

kind

string

Este es un tipo de recurso.

etags

string

ETag del recurso.

floorNames[]

string

Los nombres visibles de todos los pisos de este edificio. Se espera que los pisos se ordenen de forma ascendente, desde el piso más bajo hasta el más alto. Por ejemplo, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Debe contener al menos una entrada.

address

object (BuildingAddress)

Es la dirección postal del edificio. Para obtener más información, consulta PostalAddress. Ten en cuenta que solo es necesario ingresar una línea de dirección y un código de región.

BuildingCoordinates

API pública: Resources.buildings

Representación JSON
{
  "latitude": number,
  "longitude": number
}
Campos
latitude

number

Latitud en grados decimales

longitude

number

Es la longitud en grados decimales.

BuildingAddress

API pública: Resources.buildings

Representación JSON
{
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ]
}
Campos
regionCode

string

Obligatorio. Código de región de CLDR para el país o la región de la dirección.

languageCode

string

Opcional. Código de idioma BCP-47 de los contenidos de esta dirección (si se conoce).

postalCode

string

Opcional. Código postal de la dirección.

administrativeArea

string

Opcional. División administrativa más alta que se usa para las direcciones postales de un país o una región.

locality

string

Opcional. Por lo general, se refiere a la parte de la dirección que indica la ciudad o el pueblo. Ejemplos: ciudad de EE.UU., comuna de Italia o ciudad postal en el Reino Unido. En regiones del mundo donde las localidades no están bien definidas o no coinciden bien con esta estructura, deja la localidad vacía y usa addressLines.

sublocality

string

Opcional: Sublocalidad de la dirección.

addressLines[]

string

Líneas de dirección no estructuradas que describen los niveles más bajos de una dirección.

Métodos

delete

Borra un edificio.

get

Recupera un edificio.

insert

Inserta un edificio.

list

Recupera una lista de los edificios de una cuenta.

patch

Colocar parches en un edificio

update

Actualiza un edificio.