updated API documentation

This commit is contained in:
2026-05-31 00:26:38 +02:00
parent e6e80590cc
commit 3e7f38c497
7 changed files with 182 additions and 3 deletions

View File

@@ -0,0 +1,56 @@
# DELETE Stomp
This API call deletes a stomp from a user.
#### Location
```
/api/v1/office/stompjes/
```
#### Permissions required
`office-stompjes` RW
#### Body parameters
| Parameter | Type | Required | Description |
| ---------- | ------ | -------- | ---------------------- |
| stomp_uuid | string | yes | Unique id of the stomp |
### Example Body (json)
```json
{
"stomp_uuid": "e0a60eba-52f6-11f1-8bcc-bc2411125ba4",
}
```
### Example Request
```php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => $baseUrl . '/api/v1/office/stompjes/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json_payload,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $token,
'Content-Type: application/json',
'X-HTTP-Method-Override: DELETE'
],
]);
$response = curl_exec($curl);
$httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($response === false) {
echo curl_error($curl);
}
curl_close($curl);
```
### Example Response
```json
"Stomp removed."
```
#### Known errors or issues.
None are known at the time
If you do encounter issues and get an http code in return, check the response codes on this page.