(Replaced content with "The Halligan API is the main API used by the BrandMeister Dashboard. It authenticates users and sends their queries to the correct backend servers in the decentralized Bra...")
Line 1: Line 1:
 
The Halligan API is the main API used by the BrandMeister Dashboard. It authenticates users and sends their queries to the correct backend servers in the decentralized BrandMeister Network.
 
The Halligan API is the main API used by the BrandMeister Dashboard. It authenticates users and sends their queries to the correct backend servers in the decentralized BrandMeister Network.
  
V1.0 of the API is located at:
+
V2 of the API is located at:
 
<pre>
 
<pre>
https://api.brandmeister.network
+
https://api.brandmeister.network/docs/
</pre>
+
 
+
We are currently working on a V2 (in a slow pace) which will come with swagger documentation. This API version is not public yet.
+
 
+
= API V1 Documentation =
+
== Repeater ==
+
https://api.brandmeister.network/v1.0/repeater/?action=LIST (can also be done with &callback=)
+
<pre>
+
[
+
  {
+
"repeaterid": "204342",
+
"callsign": "PI1SPA",
+
"hardware": "RD985-00000000-001000-U1-0-F",
+
"firmware": "A7.06.04.000",
+
"tx": "438.3000",
+
"rx": "430.7000",
+
"colorcode": "1",
+
"status": "3",
+
"lastKnownMaster": "2041",
+
"lat": "52.255932",
+
"lng": "5.379150",
+
"city": "Bunschoten Spakenburg",
+
"website": "https:\/\/veronamersfoort.nl\/?page_id=3701",
+
"pep": "25",
+
"gain": "0.00",
+
"agl": "29",
+
"priorityDescription": "",
+
"description": "",
+
"last_updated": "2016-12-16 14:06:50"
+
  }
+
]
+
</pre>
+
 
+
https://api.brandmeister.network/v1.0/repeater/?action=get&q=204342 (can also be done with &callback=)
+
<pre>
+
{
+
"repeaterid": "204342",
+
"callsign": "PI1SPA",
+
"hardware": "RD985-00000000-001000-U1-0-F",
+
"firmware": "A7.06.04.000",
+
"tx": "438.3000",
+
"rx": "430.7000",
+
"colorcode": "1",
+
"status": "3",
+
"lastKnownMaster": "2041",
+
"lat": "52.255932",
+
"lng": "5.379150",
+
"city": "Bunschoten Spakenburg",
+
"website": "https:\/\/veronamersfoort.nl\/?page_id=3701",
+
"pep": "25",
+
"gain": "0.00",
+
"agl": "29",
+
"priorityDescription": "",
+
"description": "",
+
"last_updated": "2016-12-16 14:15:44",
+
"sysops": [{
+
"username": "PD0ZRY",
+
"user_roles": ["REPEATER_READ", "REPEATER_USERS", "REPEATER_WRITE"]
+
}, {
+
"username": "PD0RAF",
+
"user_roles": ["REPEATER_READ", "REPEATER_USERS", "REPEATER_WRITE"]
+
}]
+
}
+
</pre>
+
 
+
https://api.brandmeister.network/v1.0/repeater/?action=profile&q=204342 (can also be done with &callback=)
+
<pre>
+
{
+
"reflector": {
+
"reflector": 0,
+
"interval": 600,
+
"active": 0
+
},
+
"staticSubscriptions": [{
+
"talkgroup": 204,
+
"networkid": 2041,
+
"repeaterid": 204342,
+
"slot": 1,
+
"type": "tarantool"
+
}, {
+
"talkgroup": 20421,
+
"networkid": 2041,
+
"repeaterid": 204342,
+
"slot": 2,
+
"type": "tarantool"
+
}, {
+
"talkgroup": 2042,
+
"networkid": 2041,
+
"repeaterid": 204342,
+
"slot": 2,
+
"type": "tarantool"
+
}],
+
"dynamicSubscriptions": [{
+
"repeaterid": 204342,
+
"talkgroup": 260,
+
"slot": 1,
+
"timeout": 1481894494.3966
+
}],
+
"timedSubscriptions": [{
+
"repeaterid": 204342,
+
"talkgroup": 123,
+
"slot": 2,
+
"data": {
+
"startDate": 1,
+
"endDate": 999999999,
+
"monday": 1,
+
"tuesday": 0,
+
"wednesday": 0,
+
"thursday": 0,
+
"friday": 0,
+
"saturday": 0,
+
"sunday": 0,
+
"start": 10,
+
"stop": 60
+
}
+
}],
+
"clusters": [{
+
"talkgroup": 8,
+
"clusterid": 204000,
+
"repeaterid": 204342,
+
"slot": 2,
+
"extTalkgroup": 0
+
}]
+
}
+
 
</pre>
 
</pre>

Revision as of 17:31, 26 August 2022

The Halligan API is the main API used by the BrandMeister Dashboard. It authenticates users and sends their queries to the correct backend servers in the decentralized BrandMeister Network.

V2 of the API is located at:

https://api.brandmeister.network/docs/

The Halligan API is the main API used by the BrandMeister Dashboard. It authenticates users and sends their queries to the correct backend servers in the decentralized BrandMeister Network.

V2 of the API is located at:

https://api.brandmeister.network/docs/