Introduction
Welcome to the NBS BIM Toolkit API Help Page
A sample website demonstrating API features can be found here.
Controllers
Definitions
The API for Object Definition and Classification Information
| # | API | Description |
|---|---|---|
| 1 | GET definitions/uniclass2015/{notation}/{depth} | Get Uniclass 2015 classification tree from a specified starting notation |
| 2 | GET definitions/uniclass2015/ancestors/{notation} | Get the ancestors of a given Uniclass notation, e.g. for providing a breadcrumb trail |
| 3 | GET definitions/loi/{notation}/{level} | Get Level of Information data for a given Uniclass notation and level |
Properties
The API for Object Definition and Classification Information
| # | API | Description |
|---|---|---|
| 1 | GET properties/propertybyid/{id} | Returns single property by id |
| 2 | GET properties/propertiesbyname/{name} | Gets properties (ClauseItemDescriptions) by name containing characters in parameter, returns IEnumerable of properties |
| 3 | GET properties/properties | Returns all properties (Property) |