Skip to main content
Eptura Knowledge Center

Endpoint - buildings

  1. Last updated
  2. Save as PDF
The API has the following endpoints:
image2022-2-21_8-48-7.png

Returns a list of available Buildings

Request URL

https://[client_instance].serraview.com/api/v2/buildings

Remember the results returned will not be the full results so you can include the resultSize to specify the maximum number of rows to return.

image2022-2-21_8-40-58.png

Model Schema

{
  "data": [
    {
      "buildingNumber": "string",
      "buildingType": {
        "id": 0,
        "name": "string"
      },
      "city": "string",
      "country": "string",
      "id": 0,
      "latitude": 0,
      "longitude": 0,
      "name": "string",
      "postcode": "string",
      "region": {
        "id": 0,
        "name": "string"
      },
      "shortName": "string",
      "showInFloorplansPage": true,
      "showInMapping": true,
      "showInPortfolioDashboard": true,
      "showInVBS": true,
      "showInWayfinding": true,
      "state": "string",
      "street": "string"
    }
  ],
  "paging": {
    "next": "string",
    "previous": "string",
    "totalItemCount": 0
  }
}

Returns a Building

Request URL

https://[client_instance].serraview.com/api/v2/buildings/{id}

image2022-2-21_8-49-24.png

Model Schema

{
  "buildingNumber": "string",
  "buildingType": {
    "id": 0,
    "name": "string"
  },
  "city": "string",
  "country": "string",
  "customFields": [
    "string"
  ],
  "id": 0,
  "latitude": 0,
  "longitude": 0,
  "name": "string",
  "postcode": "string",
  "region": {
    "id": 0,
    "name": "string"
  },
  "shortName": "string",
  "showInFloorplansPage": true,
  "showInMapping": true,
  "showInPortfolioDashboard": true,
  "showInVBS": true,
  "showInWayfinding": true,
  "state": "string",
  "street": "string",
  "tags": [
    "string"
  ]
}

Returns the active Floors for the Building Id

Request URL

https://[client_instance].serraview.com/api/v2/buildings/{id}/floors

image2022-2-21_8-50-35.png

Model Schema

{
  "buildingId": 0,
  "buildingNumberOverride": "string",
  "businessKey": "string",
  "gla": 0,
  "id": 0,
  "name": "string",
  "nla": 0,
  "sequence": 0,
  "showInFloorplansPage": true,
  "showInMapping": true,
  "showInVBS": true,
  "showInWayfinding": true
}

Returns the active People for the Building Id

Request URL

https://[client_instance].serraview.com/api/v2/buildings/{id}/people

image2022-2-21_8-52-49.png

{
  "data": [
    {
      "businessKey": "string",
      "division": {
        "id": 0,
        "name": "string"
      },
      "email": "string",
      "employeeNumber": "string",
      "firstName": "string",
      "id": 0,
      "jobTitle": "string",
      "lastName": "string",
      "logonName": "string",
      "mobileNumber": "string",
      "phoneExt": "string",
      "phoneNumber": "string",
      "team": {
        "id": 0,
        "name": "string"
      }
    }
  ],
  "paging": {
    "next": "string",
    "previous": "string",
    "totalItemCount": 0
  }
}