ManualChapters
Last updated
Last updated
ManualChapters
are a collection of ManualEntries and describe structure and permissions for Manual
contents.
manualChapter
Key | Relation | Type | Relation Field(s) |
---|---|---|---|
Sortable
Get a list of all ManualChapters
the current authenticated User is allowed to view.
Definition
GET
/api/manual/chapters
Example Request
Example Response Body
Show a single ManualChapter
by id
.
Definition
GET
/api/manual/chapters/{id}
Example Request
Example Response Body
Get a list of all ManualChapters
.
Definition
GET
/api/administration/manual/chapters
Example Request
Example Response Body
Get a single ManualChapter
by id
.
Definition
GET
/api/administration/manual/chapters/{id}
Example Request
Example Response Body
Create a new ManualChapter
.
Definition
POST
/api/administration/manual/chapters
Request Keys
Keys with *
are required.
Example Request
Example Response Body
Update an existing ManualChapter
by id
.
Definition
PUT
/api/administration/manual/chapters/{id}
Request Keys
Example Request
Example Response Body
Delete an existing ManualChapter
by id
.
Definition
DELETE
/api/administration/manual/chapters/{id}
Example Request
Example Response Body
Key | Type | Default | Description |
---|---|---|---|
Key | Type | Description |
---|---|---|
departments
Belongs to many
Intermediate table
entries
Has many
manual_chapter_entries.chapter_id
icon_id
integer
20
The Icon of the ManualChapter
.
name
*
string
-
The name of the ManualChapter
(unique by all ManualChapters
).
slug
string
Slugged name
The slugged name
of the ManualChapter
(unique by all ManualChapters
).
sort_number
integer
Current highest +1
The index of the ManualChapter
.
department_ids
string
-
The Departments that are allowed to see the ManualChapter
(seperated by comma). When empty, the ManualChapter
will be public.
icon_id
integer
The Icon of the ManualChapter
.
name
string
The name of the ManualChapter
(unique by all ManualChapters
).
slug
string
The slugged name
of the ManualChapter
(unique by all ManualChapters
).
sort_number
integer
The index of the ManualChapter
.
department_ids
string
The Departments that are allowed to see the ManualChapter
(seperated by comma). When empty, the ManualChapter
will be public.