Cocon Fiber Read-only API (v1)

Download OpenAPI specification:Download

License: Proprietary

The Cocon Fiber Read-only API provides several ways to request Cocon Fiber asset data.

This can be single-asset related data or aggregated information.

Access point

Get access points

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"type": "string",
"stage": 0,
"project": "string",
"geolocation": {"type": "Point",
"bbox": [0
]
}
}
]

Get access points by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"type": "string",
"stage": 0,
"project": "string",
"geolocation": {"type": "Point",
"bbox": [0
]
}
}

Building

Get buildings

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"complexId": "string",
"type": "string",
"stage": 0,
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [[[0,
0
],
[0,
0
],
[0,
0
],
[0,
0
]
]
]
}
}
]

Get client connections of buildings per building

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

buildingName

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"complexName": "string",
"frameNames": ["string"
],
"terminationUnitTypes": ["string"
],
"installationCompanyName": "string",
"cableInformation": [{"cableReference": {"id": "string",
"href": "string",
"name": "string"
},
"endpointReference": {"id": "string",
"href": "string",
"type": "Frame",
"geometry": {"type": "Point",
"bbox": [0
]
}
},
"cableTypeReference": {"id": "string",
"href": "string",
"name": "string"
},
"fibers": [{"index": 0,
"attenuation": 0
}
]
}
]
}

Get buildings by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"complexId": "string",
"type": "string",
"stage": 0,
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [[[0,
0
],
[0,
0
],
[0,
0
],
[0,
0
]
]
]
}
}

Get customer connections connected to a POP

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"customerConnections": [{"addressDetails": {"property1": "string",
"property2": "string"
},
"complexName": "string",
"projectName": "string",
"cableName": "string",
"frameName": "string",
"ftuType": "string",
"popConnections": [{"fiberNumber": 0,
"buildingName": "string",
"frameName": "string",
"frameRow": "string",
"terminationUnitName": "string",
"trayNumber": 0,
"patchPositionOnTray": 0,
"attenuation": 0.1,
"additionalInformation": {"property1": "string",
"property2": "string"
}
}
]
}
]
}

Get customer locations connected to a POP Deprecated. Use `/customer-connections` instead Deprecated

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"customerConnections": [{"addressDetails": {"property1": "string",
"property2": "string"
},
"complexName": "string",
"projectName": "string",
"cableName": "string",
"frameName": "string",
"ftuType": "string",
"popConnections": [{"fiberNumber": 0,
"buildingName": "string",
"frameName": "string",
"frameRow": "string",
"terminationUnitName": "string",
"trayNumber": 0,
"patchPositionOnTray": 0,
"attenuation": 0.1,
"additionalInformation": {"property1": "string",
"property2": "string"
}
}
]
}
]
}

Get client connections of a building by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"complexName": "string",
"frameNames": ["string"
],
"terminationUnitTypes": ["string"
],
"installationCompanyName": "string",
"cableInformation": [{"cableReference": {"id": "string",
"href": "string",
"name": "string"
},
"endpointReference": {"id": "string",
"href": "string",
"type": "Frame",
"geometry": {"type": "Point",
"bbox": [0
]
}
},
"cableTypeReference": {"id": "string",
"href": "string",
"name": "string"
},
"fibers": [{"index": 0,
"attenuation": 0
}
]
}
]
}

Get the slacks associated with a building

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

buildingName

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"id": "string",
"name": "string",
"stage": 0,
"location": {"id": "string",
"href": "string",
"locationType": "Unknown"
},
"project": {"id": "string",
"href": "string"
},
"cable": {"id": "string",
"href": "string",
"type": "string"
},
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [0,
0
]
}
}
]

Cable

Get cables

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"endpoints": [{"name": "string",
"type": "string",
"locationName": "string"
}
],
"type": "string",
"stage": 0,
"project": "string",
"innerducts": [{"ductReference": {"id": "string",
"href": "string"
},
"name": "string",
"color": "string",
"diameter": 0,
"owner": "string"
}
],
"capacity": 0,
"numberOfAvailableFibers": 0,
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [[0,
0
],
[0,
0
]
]
}
}
]

Get cables by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"endpoints": [{"name": "string",
"type": "string",
"locationName": "string"
}
],
"type": "string",
"stage": 0,
"project": "string",
"innerducts": [{"ductReference": {"id": "string",
"href": "string"
},
"name": "string",
"color": "string",
"diameter": 0,
"owner": "string"
}
],
"capacity": 0,
"numberOfAvailableFibers": 0,
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [[0,
0
],
[0,
0
]
]
}
}

Drilling

Get drillings

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"type": {"id": "string",
"href": "string"
},
"stage": 0,
"project": {"id": "string",
"href": "string"
},
"length": 0,
"owner": "string",
"remarks": "string",
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [[0,
0
],
[0,
0
]
]
}
}
]

Get drillings by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"type": {"id": "string",
"href": "string"
},
"stage": 0,
"project": {"id": "string",
"href": "string"
},
"length": 0,
"owner": "string",
"remarks": "string",
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [[0,
0
],
[0,
0
]
]
}
}

Get a ZIP archive containing the drilling profile for a drilling, if available

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

query Parameters

asBase64

boolean

Default: false

Responses

Response samples

401
403
404
500

Content type

application/json

{"timestamp": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": 0,
"errors": [{"code": "string",
"message": "string"
}
],
"message": "string"
}

Duct

Get ducts

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"type": "string",
"color": "string",
"diameter": 0,
"stage": 0,
"geometry": {"type": "Point",
"bbox": [0
]
},
"length": 0,
"owner": "string",
"innerducts": [{"name": "string",
"color": "string",
"diameter": 0,
"cable": "string",
"project": "string",
"duct": "string",
"owner": "string"
}
],
"numberOfAvailableInnerducts": 0,
"remarks": "string",
"project": "string",
"ductRoute": "string",
"locations": ["string"
]
}
]

Get ducts by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"type": "string",
"color": "string",
"diameter": 0,
"stage": 0,
"geometry": {"type": "Point",
"bbox": [0
]
},
"length": 0,
"owner": "string",
"innerducts": [{"name": "string",
"color": "string",
"diameter": 0,
"cable": "string",
"project": "string",
"duct": "string",
"owner": "string"
}
],
"numberOfAvailableInnerducts": 0,
"remarks": "string",
"project": "string",
"ductRoute": "string",
"locations": ["string"
]
}

Enclosure

Get enclosures

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"locationName": "string",
"name": "string",
"type": "string",
"stage": 0,
"project": "string",
"geometry": {"type": "Point",
"bbox": [0
]
}
}
]

Get enclosures by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"locationName": "string",
"name": "string",
"type": "string",
"stage": 0,
"project": "string",
"geometry": {"type": "Point",
"bbox": [0
]
}
}

Frame

Get frames

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"locationName": "string",
"name": "string",
"type": "string",
"stage": 0,
"project": "string",
"geometry": {"type": "Point",
"bbox": [0
]
}
}
]

Get frames by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"locationName": "string",
"name": "string",
"type": "string",
"stage": 0,
"project": "string",
"geometry": {"type": "Point",
"bbox": [0
]
}
}

Permit

Get permits

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"issuer": "string",
"issuerType": "string",
"project": {"id": "string",
"href": "string"
},
"remarks": "string",
"geometry": {"type": "Point",
"bbox": [0
]
}
}
]

Get permits by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"issuer": "string",
"issuerType": "string",
"project": "string",
"remarks": "string",
"geometry": {"type": "Point",
"bbox": [0
]
}
}

Project

Get projects

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"type": "string",
"locked": true,
"defaultInstallationCompany": "string",
"progressStatus": "string"
}
]

Get projects by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"type": "string",
"locked": true,
"defaultInstallationCompany": "string",
"progressStatus": "string"
}

Slack

Get the slacks associated with a building

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

buildingName

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"id": "string",
"name": "string",
"stage": 0,
"location": {"id": "string",
"href": "string",
"locationType": "Unknown"
},
"project": {"id": "string",
"href": "string"
},
"cable": {"id": "string",
"href": "string",
"type": "string"
},
"geometry": {"type": "Point",
"bbox": [0
],
"coordinates": [0,
0
]
}
}
]

Splice tray

Get splice trays

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"type": {"id": "string",
"href": "string"
},
"spliceTrayContainer": {"id": "string",
"href": "string",
"position": 0,
"side": "string",
"type": "Unknown"
},
"splicePositions": [{"position": 0,
"fiber": {"id": "string",
"href": "string"
},
"stage": 0
}
]
}
]

Patch position

Trace endpoints of a patchposition

Starts from the provided patch position and traces the network to the very end If multiple endpoints are found, it returns all of them

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

query Parameters

future

boolean

Default: false

Should the currently active network be used, or the scheduled (future) network

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"endpoints": [{"endpoint": {"type": "Unknown",
"id": "string",
"href": "string"
},
"fiber": {"id": "string",
"href": "string"
}
}
]
}
]

Access point type

Get access point types

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"isAllowed": true,
"maximumEnclosures": 0
}
]

Get access point types by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"isAllowed": true,
"maximumEnclosures": 0
}

Building type

Get building types

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"isAllowed": true
}
]

Get building types by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"isAllowed": true
}

Cable type

Get cable types

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"medium": 0,
"layout": "string",
"color": "string",
"remarks": "string",
"diameter": 0,
"numberOfFibers": 0,
"isAllowed": true,
"numberOfTubes": 0,
"tubes": [{"number": 0,
"color": "string",
"fibers": [{"number": 0,
"color": "string",
"type": {"id": "string",
"href": "string"
}
}
]
}
]
}
]

Get cable types by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"medium": 0,
"layout": "string",
"color": "string",
"remarks": "string",
"diameter": 0,
"numberOfFibers": 0,
"isAllowed": true,
"numberOfTubes": 0,
"tubes": [{"number": 0,
"color": "string",
"fibers": [{"number": 0,
"color": "string",
"type": {"id": "string",
"href": "string"
}
}
]
}
]
}

Duct type

Get duct types

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"numberOfInnerducts": 0,
"innerducts": [{"color": "string",
"diameter": 0.1
}
],
"isAllowed": true
}
]

Get duct types by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"numberOfInnerducts": 0,
"innerducts": [{"color": "string",
"diameter": 0.1
}
],
"isAllowed": true
}

Enclosure type

Get enclosure types

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"isAllowed": true,
"maximumSpliceTrays": 0,
"numberOfSpliceTrayPositions": 0
}
]

Get enclosure types by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"isAllowed": true,
"maximumSpliceTrays": 0,
"numberOfSpliceTrayPositions": 0
}

Frame type

Get frame types

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"isAllowed": true,
"numberOfRackUnits": 0,
"numberingDirection": "string",
"numberingStartsAt": 0
}
]

Get frame types by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"isAllowed": true,
"numberOfRackUnits": 0,
"numberingDirection": "string",
"numberingStartsAt": 0
}

Splice tray type

Get splice tray types

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

offset	integer <int32> Example: offset=5 The offset of the first item returned
limit	integer <int32> Example: limit=10 The maximum number of items returned
sort	string A sorting hint for the returned items
filter	string A filter specification for the returned items. Varies for different situations. See the general API documentation for examples.

Responses

Response samples

200
401
403
500

Content type

application/json

[{"id": "string",
"name": "string",
"numberOfSplicePositions": 0,
"heightInSpliceTrayPositions": 0,
"numberOfTrays": 0,
"isAllowed": true
}
]

Get splice tray types by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"numberOfSplicePositions": 0,
"heightInSpliceTrayPositions": 0,
"numberOfTrays": 0,
"isAllowed": true
}

Client connection

Get client connections of buildings per building

Authorizations:

Api-Key-HeaderClient-Id-Header

query Parameters

buildingName

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"complexName": "string",
"frameNames": ["string"
],
"terminationUnitTypes": ["string"
],
"installationCompanyName": "string",
"cableInformation": [{"cableReference": {"id": "string",
"href": "string",
"name": "string"
},
"endpointReference": {"id": "string",
"href": "string",
"type": "Frame",
"geometry": {"type": "Point",
"bbox": [0
]
}
},
"cableTypeReference": {"id": "string",
"href": "string",
"name": "string"
},
"fibers": [{"index": 0,
"attenuation": 0
}
]
}
]
}

Get client connections of a building by id

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"id": "string",
"name": "string",
"complexName": "string",
"frameNames": ["string"
],
"terminationUnitTypes": ["string"
],
"installationCompanyName": "string",
"cableInformation": [{"cableReference": {"id": "string",
"href": "string",
"name": "string"
},
"endpointReference": {"id": "string",
"href": "string",
"type": "Frame",
"geometry": {"type": "Point",
"bbox": [0
]
}
},
"cableTypeReference": {"id": "string",
"href": "string",
"name": "string"
},
"fibers": [{"index": 0,
"attenuation": 0
}
]
}
]
}

Customer connection

Get customer connections connected to a POP

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"customerConnections": [{"addressDetails": {"property1": "string",
"property2": "string"
},
"complexName": "string",
"projectName": "string",
"cableName": "string",
"frameName": "string",
"ftuType": "string",
"popConnections": [{"fiberNumber": 0,
"buildingName": "string",
"frameName": "string",
"frameRow": "string",
"terminationUnitName": "string",
"trayNumber": 0,
"patchPositionOnTray": 0,
"attenuation": 0.1,
"additionalInformation": {"property1": "string",
"property2": "string"
}
}
]
}
]
}

Get customer locations connected to a POP Deprecated. Use `/customer-connections` instead Deprecated

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

Example: 10 or 1abc

Unique identifier

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"customerConnections": [{"addressDetails": {"property1": "string",
"property2": "string"
},
"complexName": "string",
"projectName": "string",
"cableName": "string",
"frameName": "string",
"ftuType": "string",
"popConnections": [{"fiberNumber": 0,
"buildingName": "string",
"frameName": "string",
"frameRow": "string",
"terminationUnitName": "string",
"trayNumber": 0,
"patchPositionOnTray": 0,
"attenuation": 0.1,
"additionalInformation": {"property1": "string",
"property2": "string"
}
}
]
}
]
}

Trace endpoints

Trace endpoints of a patchposition

Starts from the provided patch position and traces the network to the very end If multiple endpoints are found, it returns all of them

Authorizations:

Api-Key-HeaderClient-Id-Header

path Parameters

id

required

string

query Parameters

future

boolean

Default: false

Should the currently active network be used, or the scheduled (future) network

Responses

Response samples

200
401
403
404
500

Content type

application/json

[{"endpoints": [{"endpoint": {"type": "Unknown",
"id": "string",
"href": "string"
},
"fiber": {"id": "string",
"href": "string"
}
}
]
}
]