InfoboardChannels

InfoboardChannels function as subspaces within the Infoboard. Access to each InfoboardChannel is controlled through EntityPermissions, which define the Departments that are members of the channel.

An InfoboardPost can be assigned an infoboard_channel_id, making it visible only to the Departments granted access via EntityPermissions. Additionally, InfoboardPosts in channels can further restrict access to individual Departments within the channel via the departments relation.

It is also possible to assign permissions such as write, comment and administrate for the individual Roles of the assigned Departments via EntityPermissions.

Model Definition

Alias

infoboardChannel

Relations

Key	Relation	Type	Relation Field(s)
user	User	Belongs to	user_id
folder	Folder	Belongs to	folder_id
icon	Icon	Belongs to	icon_id
entityPermissions	EntityPermissions	Morph many
infoboardPosts	InfoboardPost	Has many	infoboard_post.infoboard_channel_id

List

Get a list of all InfoboardChannels the current authenticated User is allowed to view.

Definition

GET /api/infoboard/channels

Example Request

PHP

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

Example Response Body

[
  {
    "id": 1,
    "user_id": 1,
    "folder_id": null,
    "icon_id": 10,
    "title": "Non curabitur gravida arcu ac",
    "color": "#ffffff",
    "sort_number": 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,
    "folder_id": null,
    "icon_id": 20,
    "title": "Placerat duis ultricies lacus sed",
    "color": "#000000",
    "sort_number": 2,
    "created_at": "2025-03-17 13:00:00",
    "updated_at": "2025-03-17 13:00:00",
    "deleted_at": null
  }
]

Show

Show a single InfoboardChannel by id.

Definition

GET /api/infoboard/channels/{``id}

Example Request

PHP

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

Example Response

{
  "id": 1,
  "user_id": 1,
  "folder_id": null,
  "icon_id": 10,
  "title": "Non curabitur gravida arcu ac",
  "color": "#ffffff",
  "sort_number": 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 InfoboardChannels.

Definition

GET /api/administration/infoboard/channels`

Example Request

PHP

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

Example Response Body

[
  {
    "id": 1,
    "user_id": 1,
    "folder_id": null,
    "icon_id": 10,
    "title": "Non curabitur gravida arcu ac",
    "color": "#ffffff",
    "sort_number": 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,
    "folder_id": null,
    "icon_id": 20,
    "title": "Placerat duis ultricies lacus sed",
    "color": "#000000",
    "sort_number": 2,
    "created_at": "2025-03-17 13:00:00",
    "updated_at": "2025-03-17 13:00:00",
    "deleted_at": null
  }
]

[Adm.] Show

Get a single InfoboardChannel by id.

Definition

GET /api/administration/infoboard/channels/{id}`

Example Request

PHP

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

Example Response Body

{
  "id": 1,
  "user_id": 1,
  "folder_id": null,
  "icon_id": 10,
  "title": "Non curabitur gravida arcu ac",
  "color": "#ffffff",
  "sort_number": 1,
  "created_at": "2025-03-17 12:00:00",
  "updated_at": "2025-03-17 12:00:00",
  "deleted_at": null
}

[Adm.] Create

Create a new InfoboardChannel.

Definition

POST /api/administration/infoboard/channels

Request Keys

Key	Type	Default	Description
folder_id	integer	-	The ID of Folder the InfoboardChannel is assigned to.
icon_id	integer	-	The ID of the Icon or the InfoboardChannel
title*	string	-	The title of the InfoboardChannel.
color	string	-	The color as a HEX string.
sort_number	integer	Current highest +1	The index of the InfoboardChannel related to the Folder.

Keys with * are required.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/administration/infoboard/channels', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'icon_id' => 30,
        'title' => 'Sagittis purus sit amet volutpat',
        'color' => '#cccccc'
    ]
]);

Example Response Body

{
  "status": "success",
  "data": {
    "id": 3,
    "user_id": 1,
    "folder_id": null,
    "icon_id": 30,
    "title": "Sagittis purus sit amet volutpat",
    "color": "#cccccc",
    "sort_number": 3,
    "created_at": "2025-03-17 14:00:00",
    "updated_at": "2025-03-17 14:00:00",
    "deleted_at": null
  }
}

[Adm.] Update

Update an existing InfoboardChannel by id.

Definition

PUT /api/administration/infoboard/channels/{id}

Request Keys

Key	Type	Description
folder_id	integer	The ID of Folder the InfoboardChannel is assigned to.
icon_id	integer	The ID of the Icon or the InfoboardChannel
title	string	The title of the InfoboardChannel.
color	string	The color as a HEX string.
sort_number	integer	The index of the InfoboardChannel related to the Folder.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('PUT', '/api/administration/infoboard/channels/3', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'icon_id' => 40,
        'color' => '#dddddd'
    ]
]);

Example Response Body

{
  "status": "success",
  "data": {
    "id": 3,
    "user_id": 1,
    "folder_id": null,
    "icon_id": 40,
    "title": "Sagittis purus sit amet volutpat",
    "color": "#dddddd",
    "sort_number": 3,
    "created_at": "2025-03-17 14:00:00",
    "updated_at": "2025-03-17 15:00:00",
    "deleted_at": null
  }
}

[Adm.] Delete

Delete an existing InfoboardChannel by id.

Definition

DELETE /api/administration/infoboard/channels/{id}

Example Request

PHP

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

Example Response Body

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