Buildings

Types

type Building {
    id: number
    name: string
    accessDescription: string
    additionalInformation: string
    currencyCode: ISO4217
    locationDescription: string
    marketingTitle: string
    marketingDescription: string
    numberOfFloors: number
    spaceDescription: string
    transitDescription: string
    coverImage: string
    destroyable: boolean
    editableAddress: boolean
    multiUnitGroupsCount: number
    propertiesCount: number
    translations: Translation[]
    address: Address
    createdAt: ISO8601
    lastUpdatedAt: ISO8601
}

type Translation {
    locale: string # ISO639-1 - https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes
    marketingTitle: string
    marketingDescription: string
    spaceDescription: string
    transitDescription: string
    locationDescription: string
    additionalInformation: string
}

type ISO4217 = string # https://en.wikipedia.org/wiki/ISO_4217

type Address {
    id: number
    city: string
    country: string # "Spain"
    countryCode: string # "ES"
    floor: string
    lat: number
    lng: number
    postCode: string
    region: string
    street1: string
    street2: string
}

Search / List buildings

input BuildingSearchQueryInput {
   workspaceIds: ID[]
}

query {
    spaces {
       buildings {
          search(
             q: BuildingSearchQueryInput
          ) {
             edges {
                node {
                   # Building
                }
             }
          }   
       }
    }
}

* For brevity cursor types have been excluded - See Pagination (Cursors)

** For brevity most connection keys have been excluded - See Connections

Get building

query {
    spaces {
       building(buildingId: ID) {
          # Building
       }
    }
}

In addition to the building data returned. You are also able to retrieve related data such as unitTypes using the same query as found on Unit Types

Edit building

mutation {
    spaces {
       buildings {
          update(
             buildingId: ID
             data: Building
          ) {
             # Building
          }   
       }
    }
}

Delete building

mutation {
    spaces {
       buildings {
          delete(
             buildingId: ID
          ) 
       }
    }
}