REST Resource: resources.buildings

    Resource: Building

    Public API: Resources.buildings

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

    string

    Unique identifier for the building. The maximum length is 100 characters.
    buildingName

    string

    The building name as seen by users in Calendar. Must be unique for the customer. For example, "NYC-CHEL". The maximum length is 100 characters.
    description

    string

    A brief description of the building. For example, "Chelsea Market".
    coordinates

    object ( BuildingCoordinates )

    The geographic coordinates of the center of the building, expressed as latitude and longitude in decimal degrees.
    kind

    string

    Kind of resource this is.
    etags

    string

    ETag of the resource.
    floorNames[]

    string

    The display names for all floors in this building. The floors are expected to be sorted in ascending order, from lowest floor to highest floor. For example, ["B2", "B1", "L", "1", "2", "2M", "3", "PH"] Must contain at least one entry.
    address

    object ( BuildingAddress )

    The postal address of the building. See PostalAddress for details. Note that only a single address line and region code are required.

    BuildingCoordinates

    Public API: Resources.buildings

    JSON representation 
     { 
 "latitude" 
 : 
 number 
 , 
 "longitude" 
 : 
 number 
 }
    Fields
    latitude

    number

    Latitude in decimal degrees.
    longitude

    number

    Longitude in decimal degrees.

    BuildingAddress

    Public API: Resources.buildings

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

    string

    Required. CLDR region code of the country/region of the address.
    languageCode

    string

    Optional. BCP-47 language code of the contents of this address (if known).
    postalCode

    string

    Optional. Postal code of the address.
    administrativeArea

    string

    Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
    locality

    string

    Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.
    sublocality

    string

    Optional. Sublocality of the address.
    addressLines[]

    string

    Unstructured address lines describing the lower levels of an address.

    Methods

    delete

    		Deletes a building.

    get

    		Retrieves a building.

    insert

    		Inserts a building.

    list

    		Retrieves a list of buildings for an account.

    patch

    		Patches a building.

    update

    		Updates a building.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: