InfoboardDepartmentSettings

InfoboardDepartmentSettings store settings for a Department in the context of the Infoboard. For example the default InfoboardChannel ID.

Alias

infoboardDepartmentSettings

Relations

Key	Relation	Type	Relation Field(s)
user	User	Belongs to	user_id
department	Department	Belongs to	department_id

Show

Show the current user's InfoboardDepartmentSettings.

Definition

GET /api/infoboard/department-settings/current

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/infoboard/department-settings/current', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

{
  "id": 1,
  "user_id": 1,
  "department_id": 1,
  "settings": {
    "default_channel_id": 1
  },
  "created_at": "2025-03-17 12:00:00",
  "updated_at": "2025-03-17 12:00:00",
  "deleted_at": null
}

[Adm.] List

Get a list of all InfoboardDepartmentSettings.

Definition

GET /api/administration/infoboard/department-settings

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/administration/infoboard/department-settings', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response Body

[
  {
    "id": 1,
    "user_id": 1,
    "department_id": 1,
    "settings": {
      "default_channel_id": 1
    },
    "created_at": "2025-03-17 12:00:00",
    "updated_at": "2025-03-17 12:00:00",
    "deleted_at": null
  },
  {
    "id": 2,
    "user_id": 1,
    "department_id": 2,
    "settings": {
      "default_channel_id": 2
    },
    "created_at": "2025-03-17 13:00:00",
    "updated_at": "2025-03-17 13:00:00",
    "deleted_at": null
  }
]

[Adm.] Show

Show InfoboardDepartmentSettings by department_id.

Definition

GET /api/administration/infoboard/department-settings/{department_id}

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/administration/infoboard/department-settings/1', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response Body

{
  "id": 1,
  "user_id": 1,
  "department_id": 1,
  "settings": {
    "default_channel_id": 1
  },
  "created_at": "2025-03-17 12:00:00",
  "updated_at": "2025-03-17 12:00:00",
  "deleted_at": null
}

[Adm.] Create or update

Create new InfoboardDepartmentSettings. When InfoboardDepartmentSettings with the given data already exits, the updated_at timestamp will be updated.

Definition

POST /api/administration/infoboard/department-settings/{department_id}

Request Keys

Key	Type	Default	Description
department_id*	integer	-	The ID of the Department that the settings relate to.
settings*	array	-	The array with the infoboard settings.
settings.default_channel_id*	integer	-	The ID of the default InfoboardChannel.

Keys with * are required.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/administration/infoboard/department-settings/1', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'department_id' => 1,
        'settings': [
            'default_channel_id': 1
        ]
    ]
]);

Example Response Body

{
  "id": 1,
  "user_id": 1,
  "department_id": 1,
  "settings": {
    "default_channel_id": 1
  },
  "created_at": "2025-03-17 12:00:00",
  "updated_at": "2025-03-17 12:00:00",
  "deleted_at": null
}

[Adm.] Delete

Delete existing InfoboardDepartmentSettings by department_id.

Definition

DELETE /api/administration//infoboard/department-settings/{department_id}

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('DELETE', '/api/administration//infoboard/department-settings/3', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response Body

{
  "status": "success",
  "data": null
}