Customer connections
In order to retrieve information about customer locations connected to a specific building, the CustomerConnection endpoint can be used. The signature of this API is as follows.
GET /api/v1/buildings/{id}/customer-connections
This traces the connections from all of the patch positions in the building to their endpoints and returns information about the buildings of type 'customer location' when those are connected to the specified building. Whenever this is not the case, an empty collection will be returned.
Characteristics
Read-only
The CustomerConnections API does not support ways to manipulate data. It does not support POST, PUT, DELETE, etc. operations.
Actuality of data
In order to be able to support a high demand for data without negative impact on the asset management system itself, the CustomerConnections API operates on an abstract of the live Cocon Fiber database. This means that the data may be out-of-sync with a maximum timespan of 24 hours.
Quality of service
The availability of the CustomerConnections API is similar to the other Cocon Fiber APIs, but the CustomerConnections API is designed to handle a much higher demand. Dependent on the type of subscription, specific rate limiting and/or quota measures may be in effect though (see the general rate limiting information on the APIs overview page).
Filtering and paging
Filtering is not applicable for the CustomerConnections API. It is, however, possible to filter the buildings for which the customer connections are requested. Refer to the Read-only API page to see which options exists for the filtering of building assets. Paging conforms to the general paging principles of the Cocon Fiber APIs. See the general information about paging on the APIs overview page.
Security
The CustomerConnections API uses system context authentication. See the general information about system context authentication on the APIs overview page. Usage Guidelines There are certain specifics with regard to the usage of the CustomerConnections API, which are described below.
General usage
Customer connections are requested on building assets. So the general procedure for getting customer connection information is: Retrieve relevant building assets using the Read-only API, optionally using filters to limit the resulting set. Retrieve the customer connections via these buildings.
Request building assets matching the POP building type.
/api/v1/buildings?filter=[type] in ('Pop')
And then, based on the result (e.g. building 123), perform the following request.
/api/v1/buildings/123/customer-connections
You can find the Customer connections API Specifications here