Tickets Routes

Create a new ticket

POST /tickets/create

This will create a ticket in the database

Headers

Name

Value

Content-Type

application/json

Authorization

<key>

Body

Response

{
    "created": boolean
}

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

This will close a ticket

POST /tickets/close

This will close a ticket with a ticket short id.

Headers

Name

Value

Content-Type

application/json

Authorization

<key>

Body

Name

Type

Description

shortId

string

This is the ticket short id

Response

{
    "closed": boolean
}

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

This will claim a ticket

POST /tickets/claim

This will claim a ticket from a short id.

Headers

Name

Value

Content-Type

application/json

Authorization

<key>

Body

Name

Type

Description

shortId

string

This is the ticket short id

discordId

string

This is the users discord id

Response

{
    "claimed": boolean
}

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

Is a specific user the claimer of a ticket

GET /tickets/is/claimer/[ User Id ]/[ Short Id ]

This will claim a ticket from a short id.

Headers

Name

Value

Content-Type

application/json

Authorization

<key>

Request

Name

Type

Description

Short Id

string

This is the ticket short id

User Id

UUIDv4

This is the users database id

Response

{
    "IsClaimer": boolean
}

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

Is the ticket claimed

GET /tickets/is/claimed/[ Short Id ]

This will claim a ticket from a short id.

Headers

Name

Value

Content-Type

application/json

Authorization

<key>

Request

Name

Type

Description

Short Id

string

This is the ticket short id

Response

{
    "claimed": boolean
}

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

Get a tickets claimer

GET /tickets/is/claimed/[ Short Id ]

This will return the user database id of the claimer for a specific ticket

Headers

Name

Value

Content-Type

application/json

Authorization

<key>

Request

Name

Type

Description

Short Id

string

This is the ticket short id

Response

If can find a ticket that has been claimed with a specific short id:

{
    "claimer": "string"
}

If cannot find a ticket that has been claimed with specific short id:

{
    "claimer": ""
}

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

Get a ticket types channel id

GET /tickets/get/channel/[ Ticket Type ]/[ Guild Id ]

This will return the user database id of the claimer for a specific ticket

Headers

Name

Value

Content-Type

application/json

Authorization

<key>

Request

Name

Type

Description

Ticket Type

string

This is the ticket type

Guild Id

string

This is the discords guild id

Response

If can find a specific ticket types channel:

{
    "channel": "string"
}

If cannot find a specific ticket types channel:

{
    "channel": ""
}

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

Get a ticket from a short id

GET /tickets/get/id/[ Short Id ]

This will return the ticket information from a short id.

Headers

Name

Value

Content-Type

application/json

Authorization

<key>

Request

Name

Type

Description

Short Id

string

This is the ticket short id

Response

If can find a specific ticket from a short id:

{
    "ticketId": "OOOOOOO-OOOO-OOOO-OOOO-OOOOOOOOOOOO",
    "ticketType": "string",
    "ticketData": "json",
    "ticketName": "string",
    "ticketShortId": "string",
    "guildId": "string",
    "ticketOwner": "string",
    "claimedBy": "string",
    "claimed": boolean,
    "closed": boolean
}

If cannot find a specific ticket from a short id:

null

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

Get a ticket from a name

GET /tickets/get/name/[ Ticket Name ]

This will return the ticket information from a ticket name

Headers

Name

Value

Content-Type

application/json

Authorization

<key>

Request

Name

Type

Description

Ticket Name

string

This is the name of the ticket

Response

If can find a specific ticket from a short id:

{
    "ticketId": "OOOOOOO-OOOO-OOOO-OOOO-OOOOOOOOOOOO",
    "ticketType": "string",
    "ticketData": "json",
    "ticketName": "string",
    "ticketShortId": "string",
    "guildId": "string",
    "ticketOwner": "string",
    "claimedBy": "string",
    "claimed": boolean,
    "closed": boolean
}

If cannot find a specific ticket from a short id:

null

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

Create a new Ticket Channel

POST /tickets/create/channel

This will assign a specific ticket type to a discord channel id

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name

Type

Description

id

UUIDv4

The Database Id for the Ticket Channel

ticketType

string

The ticket type for the channel

guildId

string

The discord guild id

channelId

string

The discord channel id

Response

{
    "created": boolean
}

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

PreviousDefault Value Routes NextButton Routes

Last updated 1 year ago