AlphaAlpha Docs
API Reference

Portal Tickets

Client portal ticket endpoints

List client's tickets

GET
/portal/tickets

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

page?integer
Default0
Formatint32
size?integer
Default20
Formatint32

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/portal/tickets"
{
  "content": [
    {
      "category": "string",
      "created": "2019-08-24T14:15:22Z",
      "id": "string",
      "lastMessageAt": "2019-08-24T14:15:22Z",
      "messageCount": 0,
      "priority": "LOW",
      "status": "PENDING_VERIFICATION",
      "subject": "string",
      "ticketNumber": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Create ticket from portal

POST
/portal/tickets

Authorization

AuthorizationBearer <token>

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/portal/tickets" \  -F data="{\n  \"description\": \"string\",\n  \"subject\": \"string\"\n}"
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "category": "string",
  "created": "2019-08-24T14:15:22Z",
  "description": "string",
  "elapsedMinutes": 0,
  "id": "string",
  "messages": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "internal": true,
      "senderId": "string",
      "senderName": "string",
      "senderType": "CLIENT"
    }
  ],
  "priority": "LOW",
  "status": "PENDING_VERIFICATION",
  "subject": "string",
  "ticketNumber": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get ticket detail

GET
/portal/tickets/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/portal/tickets/string"
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "category": "string",
  "created": "2019-08-24T14:15:22Z",
  "description": "string",
  "elapsedMinutes": 0,
  "id": "string",
  "messages": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "internal": true,
      "senderId": "string",
      "senderName": "string",
      "senderType": "CLIENT"
    }
  ],
  "priority": "LOW",
  "status": "PENDING_VERIFICATION",
  "subject": "string",
  "ticketNumber": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Reply to ticket from portal

POST
/portal/tickets/{id}/messages

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/portal/tickets/string/messages" \  -F data="{\n  \"content\": \"string\"\n}"
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "category": "string",
  "created": "2019-08-24T14:15:22Z",
  "description": "string",
  "elapsedMinutes": 0,
  "id": "string",
  "messages": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "content": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "internal": true,
      "senderId": "string",
      "senderName": "string",
      "senderType": "CLIENT"
    }
  ],
  "priority": "LOW",
  "status": "PENDING_VERIFICATION",
  "subject": "string",
  "ticketNumber": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Portal Finance

Previous Page

Portal

Next Page