Topology Server (2.0.2)

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.

Find out more about the topology api

Authentication

bearerAuth

Needed if auth is turned on

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

auth

authorization

get bearer token

Request Body schema: application/json

credentials of the user

userName	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"userName": "test",
"password": "test"
}

Response samples

200

Content type

application/json

{"token": "string"
}

unauthorized redirect

Info to user he isn't authorized

Responses

network

Everything about the network

More info about GeoJSON

Get site by id

path Parameters

siteId

required

string

ID of site to return

Responses

Response samples

200

Content type

application/json

{"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"
}

Get site by name

path Parameters

siteName

required

string

Name of site to return

Responses

Response samples

200

Content type

application/json

{"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"
}

Get site which contains the device

path Parameters

deviceId

required

string

ID of site to return

Responses

Response samples

200

Content type

application/json

{"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"
}

Get all sites within a boundingbox

path Parameters

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

Responses

Response samples

200

Content type

application/json

{"features": [{"geometry": "",
"value": "Feature",
"properties": {"id": "id"
}
},
{"geometry": "",
"value": "Feature",
"properties": {"id": "id"
}
}
],
"type": "FeatureCollection"
}

All paths starting at the site

path Parameters

siteId

required

string

siteId

Responses

Response samples

200

Content type

application/json

{"features": [{"geometry": "",
"value": "Feature",
"properties": {"id": "id"
}
},
{"geometry": "",
"value": "Feature",
"properties": {"id": "id"
}
}
],
"type": "FeatureCollection"
}

Get link by id

return a single link

path Parameters

linkID

required

string

ID of link to return

Responses

Response samples

200

Content type

application/json

{"azimuthB": 1.4658129805029452,
"length": 5.962133916683182,
"id": "id",
"azimuthA": 6.027456183070403,
"geolocationA": {"lon": 22.945559638799807,
"lat": -48.561554035174225
},
"siteA": "siteA",
"siteB": "siteB"
}

Get link by name

return a single link

path Parameters

linkName

required

string

ID of link to return

Responses

Response samples

200

Content type

application/json

{"azimuthB": 1.4658129805029452,
"length": 5.962133916683182,
"id": "id",
"azimuthA": 6.027456183070403,
"geolocationA": {"lon": 22.945559638799807,
"lat": -48.561554035174225
},
"siteA": "siteA",
"siteB": "siteB"
}

Get all links within a boundingbox

path Parameters

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

Responses

Response samples

200

Content type

application/json

{"features": [{"geometry": "",
"value": "Feature",
"properties": {"id": "id"
}
},
{"geometry": "",
"value": "Feature",
"properties": {"id": "id"
}
}
],
"type": "FeatureCollection"
}

Get number of sites and links in boundingbox

path Parameters

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

Responses

Response samples

200

Content type

application/json

{"sites": 0,
"links": 0
}

Get number of sites and links

Responses

Response samples

200

Content type

application/json

{"sites": 0,
"links": 0
}

linkcalculator

calculations for link analyzes

calculate free space loss

calculates freespaceloss for a given distance and frequency

path Parameters

distanceKm required	number length of link in km
frequencyGHz required	number frequency of link

Responses

Response samples

200

Content type

application/json

{"fspl": 0
}

calculate rainfall rate

path Parameters

rainvalue required	number
distanceKm required	number length of link in km
frequencyGHz required	number frequency of link
polarization required	string (Polarization) Enum: "HORIZONTAL" "VERTICAL"

Responses

Response samples

200

Content type

application/json

{"rainAttenuation": 0,
"rainFall": {"rainrate": 0,
"period": "JANUARY"
}
}

calculate annual rain loss

calculates annual rain loss for a given link

path Parameters

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"

Responses

Response samples

200

Content type

application/json

{"rainAttenuation": 0,
"rainFall": {"rainrate": 0,
"period": "JANUARY"
}
}

get worst month of rainloss

path Parameters

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"

Responses

Response samples

200

Content type

application/json

{"rainAttenuation": 0,
"rainFall": {"rainrate": 0,
"period": "JANUARY"
}
}

calculate absorption loss

path Parameters

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

Responses

Response samples

200

Content type

application/json

{"oxygenLoss": 0,
"waterLoss": 0,
"totalAbsorptionLoss": 0,
"period": "JANUARY"
}

calculate distance between two geographical points

calculates the distance in kilometers between two coordinates

path Parameters

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

Responses

Response samples

200

Content type

application/json

{"distanceInKm": 0
}

info

General information about the server

get loaded providers, running applications, etc

Responses

Response samples

200

Content type

application/json

{"runningApplications": ["string"
],
"providers": ["5GBerlin"
]
}

Get current version

Responses

Response samples

200

Content type

application/json

{"version": "string"
}