summaryrefslogtreecommitdiff
path: root/angelsharkd/src/routes/extensions/simple_busy/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'angelsharkd/src/routes/extensions/simple_busy/README.md')
-rw-r--r--angelsharkd/src/routes/extensions/simple_busy/README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/angelsharkd/src/routes/extensions/simple_busy/README.md b/angelsharkd/src/routes/extensions/simple_busy/README.md
new file mode 100644
index 0000000..dd9ba2c
--- /dev/null
+++ b/angelsharkd/src/routes/extensions/simple_busy/README.md
@@ -0,0 +1,50 @@
+# Daemon Extension `simple_busy`
+
+This extension implements simple extension busyout and release toggling.
+
+## Getting Started
+
+To enable this feature, compile `angelsharkd` with the `simple_busy` flag:
+
+```sh
+cargo build --bin angelsharkd --features simple_busy ...
+```
+
+## `POST /extensions/service/busyout` Busy-out a station
+
+The request consists of one or more entries including the ACM and extension to
+be operated on.
+
+```json
+POST /extensions/service/toggle
+[
+ {
+ "acm": "01",
+ "ext": "17571230000"
+ }
+]
+```
+
+The response is a typical `angelsharkd` OSSI reponse.
+
+```json
+[
+ {
+ "acm": "01",
+ "command": "busyout station 17571230000",
+ "error": "",
+ "fields": ["0001ff00", "0002ff00", "0005ff00", "0003ff00", "0004ff00"],
+ "datas": [["S075157", "DIG-IP-S", "17571230000", "ABORT", "1010"]]
+ }
+]
+```
+
+## `POST /extensions/service/release` Release a station
+
+This endpoint works identically to the busyout endpoint, but the response will
+indicate whether the station was released.
+
+## `POST /extensions/service/toggle` Busyout and then immediately release a station
+
+This endpoint runs two OSSI commands for busyout-ing and releasing the given
+stations, respectively.