Appearance
User - Ticket Categories
Base URL:
https://your-domain.com
Admin endpoints for managing ticket categories. Categories are used to classify support tickets. All endpoints require admin/staff authentication.
Fetch All Ticket Categories
Retrieve all ticket categories for the given ISP/Branch.
| Property | Value |
|---|---|
| Method | GET |
| URL | /api/v1/ticket-categories |
| Authentication | Bearer Token |
Request Headers:
| Header | Value | Required |
|---|---|---|
Accept | application/json | Yes |
Authorization | Bearer your-auth-token | Yes |
Query Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
isp_id | integer | Yes | ISP ID |
branch_id | integer | Yes | Branch ID |
Success Response (200 OK):
json
{
"status": "success",
"data": [
{
"id": 1,
"name": "Network Issue",
"isp_id": 1,
"branch_id": 1,
"created_at": "2024-01-01 00:00:00"
}
]
}Fetch Ticket Category
Retrieve details of a specific ticket category.
| Property | Value |
|---|---|
| Method | GET |
| URL | /api/v1/ticket-categories/{id} |
| Authentication | Bearer Token |
Path Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Ticket Category ID |
Query Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
isp_id | integer | Yes | ISP ID |
branch_id | integer | Yes | Branch ID |
Success Response (200 OK):
json
{
"status": "success",
"data": {
"id": 1,
"name": "Network Issue",
"isp_id": 1,
"branch_id": 1,
"created_at": "2024-01-01 00:00:00"
}
}Error Response (404 Not Found):
json
{
"status": "error",
"message": "Ticket category not found."
}Create Ticket Category
Create a new ticket category.
| Property | Value |
|---|---|
| Method | POST |
| URL | /api/v1/ticket-categories |
| Authentication | Bearer Token |
Request Headers:
| Header | Value | Required |
|---|---|---|
Content-Type | application/json | Yes |
Accept | application/json | Yes |
Authorization | Bearer your-auth-token | Yes |
Request Body:
json
{
"isp_id": 1,
"branch_id": 1,
"user_id": 1,
"name": "Network Issue"
}| Parameter | Type | Required | Description |
|---|---|---|---|
isp_id | integer | Yes | ISP ID |
branch_id | integer | Yes | Branch ID |
user_id | integer | Yes | Acting user ID |
name | string | Yes | Category name |
Success Response (201 Created):
json
{
"status": "success",
"message": "Ticket category created successfully.",
"data": {
"id": 2,
"name": "Network Issue"
}
}Update Ticket Category
Update an existing ticket category.
| Property | Value |
|---|---|
| Method | PUT |
| URL | /api/v1/ticket-categories/{id} |
| Authentication | Bearer Token |
Path Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Ticket Category ID |
Request Body:
json
{
"isp_id": 1,
"branch_id": 1,
"user_id": 1,
"name": "Network Issue Updated"
}Success Response (200 OK):
json
{
"status": "success",
"message": "Ticket category updated successfully."
}Delete Ticket Category
Delete a ticket category.
| Property | Value |
|---|---|
| Method | DELETE |
| URL | /api/v1/ticket-categories/{id} |
| Authentication | Bearer Token |
Path Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Ticket Category ID |
Query Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
isp_id | integer | Yes | ISP ID |
branch_id | integer | Yes | Branch ID |
user_id | integer | Yes | Acting user ID |
Success Response (200 OK):
json
{
"status": "success",
"message": "Ticket category deleted successfully."
}