Siradel Web services API documentation is available through its enriched Swagger documentation. You can find all API routes, and usage samples.
Access API documentation on our API documentation site
Simulation API function example
Main API route allows to run area or point to point coverage.
/my-server/simulations
Simulation scenario is embeeded in body description, in a json format, as described in the example below.
JSON
{
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "my_simulation",
"description": "string",
"calculationSessionUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"propagationRequest": {
"resultTypes": [
"RECEIVED_POWER"
],
"zmeaning": "ZMEANING_GROUND",
"propagationScenarios": [
{
"baseStation": {
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "BS1",
"description": "BS1",
"sessionUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"x": 3215621,
"y": 2456451,
"z": 35,
"epsgCode": 32612,
"zmeaning": "ZMEANING_GROUND",
"networkId": 0,
"antennaUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"azimuth": 120,
"downtilt": 0,
"additionalElectricalDowntilt": 0,
"transmitPower": 0,
"carrierFrequency": 0,
"techno": "string",
},
"userEquipments": [
{
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"sessionUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"heights": [
1.5
],
"zmeaning": "ZMEANING_GROUND",
"type": "AREA",
"antennaUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
}
],
"propagationModelUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"extendedOf": 0
}
],
"priority": 0,
"isotropic": true,
"force": true
},
"postprocessingRequest": {
"resolution": 0,
"computationType": "Custom",
"resultTypes": [
"DL_BEST_SIGNAL"
],
}
}