Skip to content

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.

PropertyValue
MethodGET
URL/api/v1/ticket-categories
AuthenticationBearer Token

Request Headers:

HeaderValueRequired
Acceptapplication/jsonYes
AuthorizationBearer your-auth-tokenYes

Query Parameters:

ParameterTypeRequiredDescription
isp_idintegerYesISP ID
branch_idintegerYesBranch 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.

PropertyValue
MethodGET
URL/api/v1/ticket-categories/{id}
AuthenticationBearer Token

Path Parameters:

ParameterTypeRequiredDescription
idintegerYesTicket Category ID

Query Parameters:

ParameterTypeRequiredDescription
isp_idintegerYesISP ID
branch_idintegerYesBranch 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.

PropertyValue
MethodPOST
URL/api/v1/ticket-categories
AuthenticationBearer Token

Request Headers:

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer your-auth-tokenYes

Request Body:

json
{
    "isp_id": 1,
    "branch_id": 1,
    "user_id": 1,
    "name": "Network Issue"
}
ParameterTypeRequiredDescription
isp_idintegerYesISP ID
branch_idintegerYesBranch ID
user_idintegerYesActing user ID
namestringYesCategory 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.

PropertyValue
MethodPUT
URL/api/v1/ticket-categories/{id}
AuthenticationBearer Token

Path Parameters:

ParameterTypeRequiredDescription
idintegerYesTicket 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.

PropertyValue
MethodDELETE
URL/api/v1/ticket-categories/{id}
AuthenticationBearer Token

Path Parameters:

ParameterTypeRequiredDescription
idintegerYesTicket Category ID

Query Parameters:

ParameterTypeRequiredDescription
isp_idintegerYesISP ID
branch_idintegerYesBranch ID
user_idintegerYesActing user ID

Success Response (200 OK):

json
{
    "status": "success",
    "message": "Ticket category deleted successfully."
}

www.onezeroart.com