npm package: @one-view/pd-oneview-active-cases-types
Description: oneview backend for active cases
Latest version: 0.0.14


FORMAT: 1A
VERSION: 1.0.0
HOST: https://api.pd-oneview.net/active-cases

# pd-oneview-active-cases

oneview backend for active cases




## Organizations list [/v1/organizations]

Organizations list for active cases

### Get [GET]
+ Request

    + Headers

            Authorization: bearer token

+ Response 200 (application/json)
    + Attributes (OrganizationList)

+ Response 404 (application/json)
    + Attributes (Error)

+ Response 500 (application/json)
    + Attributes (Error)

## Queues list [/v1/queues]

Queues list for active cases

### Get [GET]
+ Request

    + Headers

            Authorization: bearer token

+ Response 200 (application/json)
    + Attributes (QueueList)

+ Response 404 (application/json)
    + Attributes (Error)

+ Response 500 (application/json)
    + Attributes (Error)

## Tickets data [/v1/tickets]

Tickets data with filter, sorting and pagination for active cases

### Get tickets [GET /v1/tickets{?filter.status,filter.organization,filter.queue,orderBy,direction,cursor,pageSize}]

+ Parameters
    + filter.status (optional, ChatStatus)
    + filter.organization (optional, Organizations)
    + filter.queue (optional, string)
    + orderBy (optional, string)
    + direction (optional, SortOrder)
    + cursor (optional, string)
    + pageSize (optional, int32)
        + Default: `10`

+ Request

    + Headers

            Authorization: bearer token

+ Response 200 (application/json)
    + Attributes (GetTicketsResponse)

+ Response 400 (application/json)
    + Attributes (Error)

+ Response 401 (application/json)
    + Attributes (Error)

+ Response 403 (application/json)
    + Attributes (Error)

+ Response 404 (application/json)
    + Attributes (Error)

+ Response 500 (application/json)
    + Attributes (Error)

# Data Structures

## int32 (number)
## int64 (number)

## `error_object` (object)
+ status (string)
+ title (string)

## `Error` (object)
+ errors (array[error_object], fixed-type)

## QueueList
+ list (array[string]) - List of queues name from workflow server

## OrganizationList
+ list (array[Organization]) - List of organizations

## ChatStatus (enum)
+ `Active`
+ `Closed`

## Organization (enum)
+ `FP`
+ `SBTMY`
+ `ACCLA`
+ `MIBS`
+ `AMKH`
+ `TCJP`
+ `TCT`
+ `IBEX`
+ `GENEX`
+ `MBPK`
+ `ACC`
+ `TCMY`
+ `SSC`
+ `IBEXPK`

## GetTicketsResponse
+ tickets (array[Ticket], fixed-type) - list of ticket
+ cursor (Cursor, required) - object of pagination cursor
+ pageSize: 10 (int32)

## SortOrder (enum)
+ asc
+ desc

## Ticket
+ id             : `f4b8f8e5-365a-4ed1-a122-0f4ba1afef44` (string, required) - ticket id
+ isChatClosed   : true (boolean, required) - chat ticket status
+ agent          : `agent` (string) - assigned agent name
+ queueName      : `fp-tw-cmn` (string) - queue name of the ticket
+ organization   : `FP` (string) - organization of the agent
+ requestedTime  : 1572499999 (int64) - time at which this ticket created
+ assignedTime   : 1572499999 (int64) - time at which this ticket assigned
+ chatClosedTime : 1572499999 (int64) - time at which this chat room closed
+ currentTime    : 1572499999 (int64) - current time at server, for calculation in FE

## Cursor
+ currentPage: `tokenA` (string, required)
+ nextPage: `tokenB` (string, required)
+ previousPages (array[string], required, fixed-type)