Different GET API calls documented

This commit is contained in:
2026-06-14 23:37:33 +02:00
parent 4a1c6bde48
commit 8746058c79
8 changed files with 357 additions and 17 deletions

View File

@@ -10,7 +10,10 @@ This call gets all the permissions data.
`admin-access-control-permissions` RO.
#### Body parameters
None.
| Parameter | Type | Required | Description |
| -------------------- | ------ | -------- | ----------- |
| builder[0][where][0] | string | no | |
| builder[0][where][1] | string | no | |
### Example Body (json)
None.
@@ -20,7 +23,7 @@ None.
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => $baseUrl . '/api/v1/portal-management/permissions/',
CURLOPT_URL => $baseUrl . '/api/v1/portal-management/permissions/' . '?builder[0][where][0]=permission_name&builder[0][where][1]=admin-portalsettings',
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
@@ -31,13 +34,23 @@ curl_setopt_array($curl, array(
$response = curl_exec($curl);
curl_close($curl);
curl_close($curl);
echo $response;
```
### Example Response
```json
[
{
"permission_uuid":"1d018159-3109-11f0-9300-7e99ed98b725",
"permission_name":"admin-portalsettings",
"permission_slugify":"admin-portalsettings",
"permission_description":"Grants access to modify the global settings. It is advisable to restrict this permission to only the highest-level administrators.",
"permission_create_timestamp":1749933229,
"permission_modified_timestamp":null,
"module_uuid":"0f044275-1744-444c-9627-736310d7997e"
}
]
```
#### Known errors or issues.