POST /queues/{queueId}/admit - Fanfare Documentation

POST

queues

{queueId}

admit

cURL

curl --request POST \
  --url https://consumer.fanfare.io/api/queues/{queueId}/admit \
  --header 'Content-Type: application/json' \
  --data '
{
  "consumerId": "<string>"
}
'

{
  "estimatedWaitTimeInSeconds": 123,
  "position": 123,
  "status": "<unknown>"
}

Path Parameters

queueId

string

required

Body

application/json

consumerId

string

required

Response

Admitted consumer to the queue

estimatedWaitTimeInSeconds

number

required

position

number

required

status

any

required

positionDisplayMode

enum<string>

Available options:

precise,

qualitative

POST /queues/{queueId}/completeComplete a queue admission

cURL

curl --request POST \
  --url https://consumer.fanfare.io/api/queues/{queueId}/admit \
  --header 'Content-Type: application/json' \
  --data '
{
  "consumerId": "<string>"
}
'

{
  "estimatedWaitTimeInSeconds": 123,
  "position": 123,
  "status": "<unknown>"
}