api-docs v5.116.0

API Docs

Table of contents

Queue

Queue - Delete

Back to top

Delete a specific queue

DELETE /queues/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/queues/<queue-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
organization string
type string Allowed values: cashier-pool,end-of-encounter,telemed-patient-pool
name string
description string
prefix string
normalTime number
isKiosk boolean

if this can be popped out as the kiosk
canAccommodateMultiple boolean
counters object[]
counters.id string Default value: auto-generated-id
counters.name string
counters.account string

if this is bound to an account
counters.tags string[]

if this is filtered through tags
tags string[]
related string[]

list of related queues
readers string[]

if has value, list of privileges that can view the items in this queue
writers string[]

if has value, list of privileges that can operate the items in this queue

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Queue - Find

Back to top

Get list of queues

GET /queues

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/queues" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
queues object[]

array of queue
queues.id string
queues.createdAt number
queues.createdBy string
queues.organization string
queues.type string Allowed values: cashier-pool,end-of-encounter,telemed-patient-pool
queues.name string
queues.description string
queues.prefix string
queues.normalTime number
queues.isKiosk boolean

if this can be popped out as the kiosk
queues.canAccommodateMultiple boolean
queues.counters object[]
queues.counters.id string Default value: auto-generated-id
queues.counters.name string
queues.counters.account string

if this is bound to an account
queues.counters.tags string[]

if this is filtered through tags
queues.tags string[]
queues.related string[]

list of related queues
queues.readers string[]

if has value, list of privileges that can view the items in this queue
queues.writers string[]

if has value, list of privileges that can operate the items in this queue

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  },
  {
    "id": "id-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  }
]

Queue - Get

Back to top

Get a specific queue

GET /queues/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/queues/<queue-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
organization string
type string Allowed values: cashier-pool,end-of-encounter,telemed-patient-pool
name string
description string
prefix string
normalTime number
isKiosk boolean

if this can be popped out as the kiosk
canAccommodateMultiple boolean
counters object[]
counters.id string Default value: auto-generated-id
counters.name string
counters.account string

if this is bound to an account
counters.tags string[]

if this is filtered through tags
tags string[]
related string[]

list of related queues
readers string[]

if has value, list of privileges that can view the items in this queue
writers string[]

if has value, list of privileges that can operate the items in this queue

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Queue - Patch

Back to top

Update queue

PATCH /queues/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
createdAt number optional Default value: currentTime
type string optional Allowed values: cashier-pool,end-of-encounter,telemed-patient-pool
name string
description string optional
prefix string optional
normalTime number optional
isKiosk boolean optional

if this can be popped out as the kiosk
canAccommodateMultiple boolean optional
counters object[] optional
counters.id string Default value: auto-generated-id
counters.name string
counters.account string

if this is bound to an account
counters.tags string[]

if this is filtered through tags
tags string[] optional
related string[] optional

list of related queues
readers string[] optional

if has value, list of privileges that can view the items in this queue
writers string[] optional

if has value, list of privileges that can operate the items in this queue

Examples

Example usage:

curl "https://yourdomain.com/queues/<queue-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "cashier-pool"
  }'

Parameters examples

json - Request-Example

{
  "type": "cashier-pool"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
organization string
type string Allowed values: cashier-pool,end-of-encounter,telemed-patient-pool
name string
description string
prefix string
normalTime number
isKiosk boolean

if this can be popped out as the kiosk
canAccommodateMultiple boolean
counters object[]
counters.id string Default value: auto-generated-id
counters.name string
counters.account string

if this is bound to an account
counters.tags string[]

if this is filtered through tags
tags string[]
related string[]

list of related queues
readers string[]

if has value, list of privileges that can view the items in this queue
writers string[]

if has value, list of privileges that can operate the items in this queue

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Queue - Post

Back to top

Create queue

POST /queues

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string optional
createdAt number optional Default value: currentTime
organization string
type string optional Allowed values: cashier-pool,end-of-encounter,telemed-patient-pool
name string
description string optional
prefix string optional
normalTime number optional
isKiosk boolean optional

if this can be popped out as the kiosk
canAccommodateMultiple boolean optional
counters object[] optional
counters.id string Default value: auto-generated-id
counters.name string
counters.account string

if this is bound to an account
counters.tags string[]

if this is filtered through tags
tags string[] optional
related string[] optional

list of related queues
readers string[] optional

if has value, list of privileges that can view the items in this queue
writers string[] optional

if has value, list of privileges that can operate the items in this queue

Examples

Example usage:

curl "https://yourdomain.com/queues" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "type": "cashier-pool",
    "organization": "org-id",
    "name": "some name"
  }'

Parameters examples

json - Request-Example

{
  "type": "cashier-pool",
  "organization": "org-id",
  "name": "some name"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
organization string
type string Allowed values: cashier-pool,end-of-encounter,telemed-patient-pool
name string
description string
prefix string
normalTime number
isKiosk boolean

if this can be popped out as the kiosk
canAccommodateMultiple boolean
counters object[]
counters.id string Default value: auto-generated-id
counters.name string
counters.account string

if this is bound to an account
counters.tags string[]

if this is filtered through tags
tags string[]
related string[]

list of related queues
readers string[]

if has value, list of privileges that can view the items in this queue
writers string[]

if has value, list of privileges that can operate the items in this queue

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

results matching ""

    No results matching ""