Introduction
Departments represent locations or user groups within the customer system and serve as the starting point of the permission system.
They are used to structure organizational units, which are essential for assigning permissions and managing access to content in various modules.
The assignment of content is typically based either on specific or on the associated Department.
Model Definition
Alias
department
Relations
Key
Relation
Type
Relation Field(s)
List
Get a list of all Departments.
Definition
GET /api/departments
Example Request
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/departments', [
'headers' => ['Authorization' => "Bearer {accessToken}"]
]);
Example Response
[
{
"id": 2,
"name": "Standort 01",
"user_id": 2,
"folder_id": null,
"created_at": "2019-01-15 12:00:00",
"updated_at": "2019-01-15 12:00:00",
"deleted_at": null
},
{
"id": 3,
"name": "Standort 02",
"user_id": 2,
"folder_id": null,
"created_at": "2019-01-15 13:00:00",
"updated_at": "2019-01-15 13:00:00",
"deleted_at": null
}
]
Show
Show a single Department by id.
Definition
GET /api/departments/{id}
Example Request
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/departments/2', [
'headers' => ['Authorization' => "Bearer {accessToken}"]
]);
Example Response
{
"id": 2,
"name": "Standort 01",
"user_id": 2,
"folder_id": null,
"created_at": "2019-01-15 12:00:00",
"updated_at": "2019-01-15 12:00:00",
"deleted_at": null
},
Show the "availability information" for Departments
Definition
GET /api/departments/availability-information
Example Request
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/departments/availability-information', [
'headers' => ['Authorization' => "Bearer {accessToken}"]
]);
Example Response
{
"total_available": 10,
"available": 8,
"used": 2
}
Create
Create a new Department.
Definition
POST /api/departments
Request Keys
Key
Type
Default
Description
The name of the Department.
Keys with * are required.
The request can fail if the maximum number of Departments is already reached.
Example Request
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/departments', [
'headers' => ['Authorization' => "Bearer {accessToken}"],
'json' => [
'name' => 'Standort 03'
]
]);
Example Response
{
"status": "success",
"data": {
"id": 4,
"name": "Standort 03",
"user_id": 2,
"folder_id": null,
"created_at": "2019-01-15 14:00:00",
"updated_at": "2019-01-15 14:00:00",
"deleted_at": null
}
}
Update
Update an existing Department by id.
Definition
PUT /api/departments/{id}
Request Keys
Key
Type
Default
Description
The name of the Department.
Example Request
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('PUT', '/api/departments/4', [
'headers' => ['Authorization' => "Bearer {accessToken}"],
'json' => [
'name' => 'Standort - 03',
]
]);
Example Response
{
"status": "success",
"data": {
"id": 4,
"name": "Standort - 03",
"user_id": 2,
"folder_id": null,
"created_at": "2019-01-15 14:00:00",
"updated_at": "2019-01-15 14:30:00",
"deleted_at": null
}
}
Delete
Delete an existing Department by id.
Definition
DELETE /api/departments/{id}
Example Request
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('DELETE', '/api/departments/4', [
'headers' => ['Authorization' => "Bearer {accessToken}"]
]);
Example Response
{
"status": "success",
"data": null
}
