DAPNET API (2.0)

Download OpenAPI specification:Download

DAPNET Core Developers: rwth-afu@online.de URL: http://github.com/dapnet-core/ License: GPLv3

Authentication

HTTP Authentication

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

calls

List all calls

All recently published calls.

Request Body schema: application/json

Array ()

id	string <uuid> Automatically generated UUID
data required	string <= 80 characters Payload of the call
priority required	integer [ 1 .. 5 ] Priority of the call, low (1) to high (5)
required	object Recipients of the call
required	object Distribution targets of the call
local	boolean Default: "false" Create a local call that is only forwarded to transmitters connected to the current node
expires_at	string <date-time>
created_by required	string The user that created the call. Will be inserted automatically with the user used for authentication.
created_at required	string <date-time> The time of creation. Will be inserted automatically.

Responses

Request samples

Payload

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"data": "string",
"priority": 1,
"recipients": {"pocsag": [{"ric": 0,
"function": 0
}
],
"subscribers": ["string"
],
"subscriber_groups": ["string"
]
},
"distribution": {"transmitters": ["string"
],
"transmitter_groups": ["string"
]
},
"local": "false",
"expires_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]

Create a call

Creates and distributes a new call.

Request Body schema: application/json

id	string <uuid> Automatically generated UUID
data required	string <= 80 characters Payload of the call
priority required	integer [ 1 .. 5 ] Priority of the call, low (1) to high (5)
required	object Recipients of the call
required	object Distribution targets of the call
local	boolean Default: "false" Create a local call that is only forwarded to transmitters connected to the current node
expires_at	string <date-time>
created_by required	string The user that created the call. Will be inserted automatically with the user used for authentication.
created_at required	string <date-time> The time of creation. Will be inserted automatically.

Responses

Request samples

Payload

Content type

application/json

{"data": "DL0ABC: Hello World",
"priority": 4,
"recipients": {"subscribers": ["dl0xyz",
"dl1xyz"
]
},
"distribution": {"transmitters": ["db0wa"
],
"transmitter_groups": ["dl.nw",
"dl.bw"
]
},
"expires_on": "2020-08-31T13:37+00:00"
}

Get a call

path Parameters

callId

required

string

Request Body schema: application/json

id	string <uuid> Automatically generated UUID
data required	string <= 80 characters Payload of the call
priority required	integer [ 1 .. 5 ] Priority of the call, low (1) to high (5)
required	object Recipients of the call
required	object Distribution targets of the call
local	boolean Default: "false" Create a local call that is only forwarded to transmitters connected to the current node
expires_at	string <date-time>
created_by required	string The user that created the call. Will be inserted automatically with the user used for authentication.
created_at required	string <date-time> The time of creation. Will be inserted automatically.

Responses

Request samples

Payload

Content type

application/json

No sample

Response samples

200

Content type

application/json

No sample

Delete a call

path Parameters

callId

required

string

Responses

transmitters

List all transmitters

query Parameters

owner

string

Filter by owner

Responses

Response samples

200

Content type

application/json

{"offset": 0,
"rows": [{"_id": "string",
"_rev": "string",
"enabled": true,
"auth_key": "string",
"coordinates": [0,
0
],
"power": 0,
"groups": ["string"
],
"owners": ["string"
],
"usage": "personal",
"aprs_broadcast": true,
"timeslots": [true
],
"antenna": {"type": "omni",
"gain": 0,
"direction": 0
},
"emergency_power": {"available": true,
"infinite": true,
"duration": 0
}
}
]
}

Create a transmitter

Request Body schema: application/json

_id required	string Callsign
_rev	string Document Revision
enabled required	boolean
auth_key required	string Secret Authentication Key
coordinates	Array of numbers 2 items [Latitude, Longitude]
power	integer Transmitter power in Watts
groups	Array of strings List of transmitter groups
owners required	Array of strings non-empty List of owners
usage required	string Enum: "personal" "widerange"
aprs_broadcast	boolean
timeslots required	Array of booleans
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_rev": "string",
"enabled": true,
"auth_key": "string",
"coordinates": [0,
0
],
"power": 0,
"groups": ["string"
],
"owners": ["string"
],
"usage": "personal",
"aprs_broadcast": true,
"timeslots": [true
],
"antenna": {"type": "omni",
"gain": 0,
"direction": 0
},
"emergency_power": {"available": true,
"infinite": true,
"duration": 0
}
}

Get a transmitter

path Parameters

transmitterId

required

string

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"_rev": "string",
"enabled": true,
"auth_key": "string",
"coordinates": [0,
0
],
"power": 0,
"groups": ["string"
],
"owners": ["string"
],
"usage": "personal",
"aprs_broadcast": true,
"timeslots": [true
],
"antenna": {"type": "omni",
"gain": 0,
"direction": 0
},
"emergency_power": {"available": true,
"infinite": true,
"duration": 0
}
}

Get the number of transmitters

query Parameters

owner

string

Filter by owner

Responses

Response samples

200

Content type

application/json

{"count": 0
}

transmitter-connection

Bootstrap a transmitter connection

Request Body schema: application/json

callsign	string Transmitter callsign
auth_key	string Secret authentication key

Responses

Request samples

Payload

Content type

application/json

{"callsign": "string",
"auth_key": "string"
}

Response samples

200

Content type

application/json

{"timeslots": [true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true
],
"nodes": [{"host": "example.com",
"reachable": true,
"last_seen": "2019-08-24T14:15:22Z"
}
]
}

Send a connection heartbeat

Request Body schema: application/json

callsign	string
auth_key	string

Responses

Request samples

Payload

Content type

application/json

{"callsign": "string",
"auth_key": "string"
}

statistics

Get the statistics

Responses

Response samples

200

Content type

application/json

{"node": {"name": "db0sda-dc2",
"host": "dapnetdc2.db0sda.ampr.org"
},
"calls": {"local": 523,
"remote": 6324
},
"nodes": {"reachable": 8,
"unreachable": 3
},
"transmitters": {"connected": {"local": 42,
"remote": 543
}
}
}

rubrics

Get a rubric

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"_rev": "string",
"description": "string",
"label": "string",
"number": 0,
"function": 0,
"owners": ["string"
],
"distribution": {"transmitters": ["string"
],
"transmitter_groups": ["string"
]
},
"defaults": {"expiration": 0,
"priority": null
},
"cyclic_transmit": {"interval": 0,
"offset": 0,
"enabled": true
}
}

Create a rubric

Request Body schema: application/json

_id required	string Rubric name
_rev	string Document Revision
description	string Long description of the rubric
label required	string <= 11 characters Short label of the rubric, that is displayed in the rubric list of Skyper pagers.
number required	integer
function required	integer [ 0 .. 3 ]
owners required	Array of strings
	object
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"_id": "string",
"_rev": "string",
"description": "string",
"label": "string",
"number": 0,
"function": 0,
"owners": ["string"
],
"distribution": {"transmitters": ["string"
],
"transmitter_groups": ["string"
]
},
"defaults": {"expiration": 0,
"priority": null
},
"cyclic_transmit": {"interval": 0,
"offset": 0,
"enabled": true
}
}

Get the news of a rubric

path Parameters

rubricId

required

string

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"items": [{"data": "string",
"priority": 1,
"expires_at": "2019-08-24T14:15:22Z"
},
{"data": "string",
"priority": 1,
"expires_at": "2019-08-24T14:15:22Z"
},
{"data": "string",
"priority": 1,
"expires_at": "2019-08-24T14:15:22Z"
},
{"data": "string",
"priority": 1,
"expires_at": "2019-08-24T14:15:22Z"
},
{"data": "string",
"priority": 1,
"expires_at": "2019-08-24T14:15:22Z"
},
{"data": "string",
"priority": 1,
"expires_at": "2019-08-24T14:15:22Z"
},
{"data": "string",
"priority": 1,
"expires_at": "2019-08-24T14:15:22Z"
},
{"data": "string",
"priority": 1,
"expires_at": "2019-08-24T14:15:22Z"
},
{"data": "string",
"priority": 1,
"expires_at": "2019-08-24T14:15:22Z"
},
{"data": "string",
"priority": 1,
"expires_at": "2019-08-24T14:15:22Z"
}
]
}

Get a rubric

path Parameters

rubricId

required

string

Get transmitter telemetry data

Get a snapshot of the current telemetry of a transmitter.

path Parameters

transmitterId

required

string

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"_type": "string",
"config": {"software": {"name": "string",
"version": "string"
},
"timeslots": [true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true
]
},
"hardware": {"platform": "string"
},
"messages": {"queued": [0,
0,
0,
0,
0
],
"sent": [0,
0,
0,
0,
0
]
},
"node": {"connected": true,
"connected_since": "2019-08-24T14:15:22Z",
"name": "string",
"port": 0
},
"onair": true
}