Get a list of teams for buildings
Description
Retrieves the supplier teams that can optionally be assigned to buildings. A building can have a predefined team of suppliers, also referred to as relations, that reflects the preferred suppliers for specific activities or service requests within that building. These teams are typically configured and maintained in advance as part of the operational setup of the property. By making this information available through the API, external applications can use the same supplier structure as configured in the platform and support aligned, consistent supplier selection across processes.
Use Case
Use this endpoint when handling a service ticket that is associated with a building. The supplier team assigned to the building can then be used to identify and assign the most suitable supplier for the reported issue. This is particularly relevant in organizations where the user processing the service ticket is not the same person who manages the supplier team configuration. In practice, these team settings are often maintained by a technical manager or object manager, while day to day service ticket handling is performed by other users.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| reference | Reference number for the building within Bloxs. This identifier must be unique across all object types within a client-specific environment. |
| externalIdentifier | Unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. |
Response fields
The response contains the fields in the table below.
| Field | Description |
|---|---|
| supplierReference | Supplier reference number. This identifier must be unique across all relation types within a client-specific environment. |
| supplierType | Name of the supplier type. Supplier types are user-configurable in the admin module. To retrieve the list of available options, use the following endpoint: Get all supplier types |
| description | Description of the supplier type, for example contractor, roofer, or glazier. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
OK