Download OpenAPI specification:Download
The Topology Server bundles topology related functionality. It offers access to physical network data of the networks 'winlab' in NY, USA and '5GBerlin' in Berlin, Germany. Additionally, it offers loss analyzes for links, such as free space loss, rain loss and gaseous absorption losses.
{- "devices": [
- {
- "manufacture": "manufacture",
- "port": [
- 0.8008281904610115,
- 0.8008281904610115
], - "id": "id",
- "type": "type"
}, - {
- "manufacture": "manufacture",
- "port": [
- 0.8008281904610115,
- 0.8008281904610115
], - "id": "id",
- "type": "type"
}
], - "links": [
- {
- "azimuthB": 1.4658129805029452,
- "length": 5.962133916683182,
- "id": "id",
- "azimuthA": 6.027456183070403,
- "geolocationA": {
- "lon": 22.945559638799807,
- "lat": -48.561554035174225
}, - "siteA": "siteA",
- "siteB": "siteB"
}, - {
- "azimuthB": 1.4658129805029452,
- "length": 5.962133916683182,
- "id": "id",
- "azimuthA": 6.027456183070403,
- "geolocationA": {
- "lon": 22.945559638799807,
- "lat": -48.561554035174225
}, - "siteA": "siteA",
- "siteB": "siteB"
}
], - "id": "id",
- "operator": "operator"
}
{- "devices": [
- {
- "manufacture": "manufacture",
- "port": [
- 0.8008281904610115,
- 0.8008281904610115
], - "id": "id",
- "type": "type"
}, - {
- "manufacture": "manufacture",
- "port": [
- 0.8008281904610115,
- 0.8008281904610115
], - "id": "id",
- "type": "type"
}
], - "links": [
- {
- "azimuthB": 1.4658129805029452,
- "length": 5.962133916683182,
- "id": "id",
- "azimuthA": 6.027456183070403,
- "geolocationA": {
- "lon": 22.945559638799807,
- "lat": -48.561554035174225
}, - "siteA": "siteA",
- "siteB": "siteB"
}, - {
- "azimuthB": 1.4658129805029452,
- "length": 5.962133916683182,
- "id": "id",
- "azimuthA": 6.027456183070403,
- "geolocationA": {
- "lon": 22.945559638799807,
- "lat": -48.561554035174225
}, - "siteA": "siteA",
- "siteB": "siteB"
}
], - "id": "id",
- "operator": "operator"
}
deviceId required | string ID of site to return |
{- "devices": [
- {
- "manufacture": "manufacture",
- "port": [
- 0.8008281904610115,
- 0.8008281904610115
], - "id": "id",
- "type": "type"
}, - {
- "manufacture": "manufacture",
- "port": [
- 0.8008281904610115,
- 0.8008281904610115
], - "id": "id",
- "type": "type"
}
], - "links": [
- {
- "azimuthB": 1.4658129805029452,
- "length": 5.962133916683182,
- "id": "id",
- "azimuthA": 6.027456183070403,
- "geolocationA": {
- "lon": 22.945559638799807,
- "lat": -48.561554035174225
}, - "siteA": "siteA",
- "siteB": "siteB"
}, - {
- "azimuthB": 1.4658129805029452,
- "length": 5.962133916683182,
- "id": "id",
- "azimuthA": 6.027456183070403,
- "geolocationA": {
- "lon": 22.945559638799807,
- "lat": -48.561554035174225
}, - "siteA": "siteA",
- "siteB": "siteB"
}
], - "id": "id",
- "operator": "operator"
}
boundingBoxCoordinates required | Array of strings 4 items Example: 20.89,50.67,30,60 latitude and longitude of the west/south and east/north corner of the bounding box, comma seperated. 4 values are requiered |
{- "features": [
- {
- "geometry": "",
- "value": "Feature",
- "properties": {
- "id": "id"
}
}, - {
- "geometry": "",
- "value": "Feature",
- "properties": {
- "id": "id"
}
}
], - "type": "FeatureCollection"
}
{- "features": [
- {
- "geometry": "",
- "value": "Feature",
- "properties": {
- "id": "id"
}
}, - {
- "geometry": "",
- "value": "Feature",
- "properties": {
- "id": "id"
}
}
], - "type": "FeatureCollection"
}
return a single link
linkID required | string ID of link to return |
{- "azimuthB": 1.4658129805029452,
- "length": 5.962133916683182,
- "id": "id",
- "azimuthA": 6.027456183070403,
- "geolocationA": {
- "lon": 22.945559638799807,
- "lat": -48.561554035174225
}, - "siteA": "siteA",
- "siteB": "siteB"
}
return a single link
linkName required | string ID of link to return |
{- "azimuthB": 1.4658129805029452,
- "length": 5.962133916683182,
- "id": "id",
- "azimuthA": 6.027456183070403,
- "geolocationA": {
- "lon": 22.945559638799807,
- "lat": -48.561554035174225
}, - "siteA": "siteA",
- "siteB": "siteB"
}
boundingBoxCoordinates required | Array of strings 4 items Example: 20.89,50.67,30,60 latitude and longitude of the west/south and east/north corner of the bounding box, comma seperated. 4 values are requiered |
{- "features": [
- {
- "geometry": "",
- "value": "Feature",
- "properties": {
- "id": "id"
}
}, - {
- "geometry": "",
- "value": "Feature",
- "properties": {
- "id": "id"
}
}
], - "type": "FeatureCollection"
}
boundingBoxCoordinates required | Array of strings 4 items Example: 20.89,50.67,30,60 latitude and longitude of the west/south and east/north corner of the bounding box, comma seperated. 4 values are requiered |
{- "sites": 0,
- "links": 0
}
rainvalue required | number |
distanceKm required | number length of link in km |
frequencyGHz required | number frequency of link |
polarization required | string (Polarization) Enum: "HORIZONTAL" "VERTICAL" |
{- "rainAttenuation": 0,
- "rainFall": {
- "rainrate": 0,
- "period": "JANUARY"
}
}
calculates annual rain loss for a given link
linkCoordinates required | Array of strings 4 items Example: 52.516361,13.324944,52.512942,13.320128 latitude and longitude of the start and endpoint of a link, must be comma seperated |
distanceKm required | number length of link in km |
frequencyGHz required | number frequency of link |
polarization required | string (Polarization) Enum: "HORIZONTAL" "VERTICAL" |
{- "rainAttenuation": 0,
- "rainFall": {
- "rainrate": 0,
- "period": "JANUARY"
}
}
linkCoordinates required | Array of strings 4 items Example: 52.516361,13.324944,52.512942,13.320128 latitude and longitude of the start and endpoint of a link, must be comma seperated |
distanceKm required | number length of link in km |
frequencyGHz required | number frequency of link |
polarization required | string (Polarization) Enum: "HORIZONTAL" "VERTICAL" |
{- "rainAttenuation": 0,
- "rainFall": {
- "rainrate": 0,
- "period": "JANUARY"
}
}
linkCoordinates required | Array of strings 4 items Example: 52.516361,13.324944,52.512942,13.320128 latitude and longitude of the start and endpoint of a link, must be comma seperated |
distanceKm required | number length of link in km |
frequencyGHz required | number frequency of link |
absorptionMethod required | string (ITURecommendation) Enum: "ITURP67610" "ITURP67611" "ITURP67612" frequency of link |
{- "oxygenLoss": 0,
- "waterLoss": 0,
- "totalAbsorptionLoss": 0,
- "period": "JANUARY"
}
calculates the distance in kilometers between two coordinates
linkCoordinates required | Array of strings 4 items Example: 52.516361,13.324944,52.512942,13.320128 latitude and longitude of the start and endpoint of a link, must be comma seperated |
{- "distanceInKm": 0
}