Categories awards are filed under. Members read; awards:manage writes.
5 endpoints.
| Method | Path | Summary |
|---|---|---|
GET | /api/communities/{communityId}/awards/categories | List award categories (members) |
POST | /api/communities/{communityId}/awards/categories | Create a category (awards:manage) |
DELETE | /api/communities/{communityId}/awards/categories/{categoryId} | Delete a category (awards:manage) |
GET | /api/communities/{communityId}/awards/categories/{categoryId} | One category (members) |
PUT | /api/communities/{communityId}/awards/categories/{categoryId} | Edit a category (awards:manage) |
GET /api/communities/{communityId}/awards/categoriesAuth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string (uuid) | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | data is the category list | — |
POST /api/communities/{communityId}/awards/categoriesAuth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string (uuid) | — |
Request body (required) — application/json
| Field | Type | Required | Description |
|---|---|---|---|
name | string | no | — |
nameArabic | string | no | — |
sortOrder | integer | no | — |
Responses
| Status | Description | Body |
|---|---|---|
201 | data is the category | — |
DELETE /api/communities/{communityId}/awards/categories/{categoryId}Auth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string (uuid) | — |
categoryId | path | yes | string | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | Deleted | — |
GET /api/communities/{communityId}/awards/categories/{categoryId}Auth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string (uuid) | — |
categoryId | path | yes | string | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | data is the category | — |
404 | Not found | — |
PUT /api/communities/{communityId}/awards/categories/{categoryId}Auth: Bearer JWT required.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
communityId | path | yes | string (uuid) | — |
categoryId | path | yes | string | — |
Request body (required) — application/json
| Field | Type | Required | Description |
|---|---|---|---|
name | string | no | — |
nameArabic | string | no | — |
sortOrder | integer | no | — |
Responses
| Status | Description | Body |
|---|---|---|
200 | data is the category | — |