Creates or updates ticket and returns ticket information. Sends information about the ticket to client (device) associated with this session id.
Body parameters:
Name | Type | Description |
|---|---|---|
session | guid, required | Device session information, received from Virtual Queues services. Can be a random guid if not relevant. |
position | optional, object | Ticket information, can contain:
|
Tag
| Code Block |
|---|
{
id: guid
iconUrl: string, optional
color: string, optional
title: {
[string]: string
}
} |
Auth:
ApiKey header
Request:
| Code Block |
|---|
curl --location --request POST 'https://ombori-queue-dev.azure-api.net/api/organizations/xyz/queues/c179a3a2-9fd7-4e12-96e7-19d9e957e094/join' \
--header 'ApiKey: XYZ' \
--header 'Content-Type: application/json' \
--data-raw '{
"session": "foo",
"position": {
"id": "5387920d-dfdd-4904-8a51-3f007effcffa",
"customerInfo": [
"Jörgen",
"Svensson",
"2200001910105"
],
"tags": [
{
"id": "3143d93f-643c-4e29-92e8-5af7b25b8c38",
"iconUrl": "https://media.omborigrid.com/media/5f55d979ce0cbb6d30c92c3e/27f54990-0f11-11ec-85ff-7bd005db4d31",
"color": "#987931",
"title": {
"en": "G"
}
}
],
}
}' |
Response:
| Code Block |
|---|
{
"positionUrl": "https://queue.dev.ombori.com/xyz/queues/c179a3a2-9fd7-4e12-96e7-19d9e957e094/positions/5387920d-dfdd-4904-8a51-3f007effcffa",
"position": {
"status": "pending",
"priority": 0,
"location": null,
"label": "A3",
"customerInfo": [
"Jörgen",
"Svensson",
"2200001910105"
],
"tags": [
{
"id": "3143d93f-643c-4e29-92e8-5af7b25b8c38",
"iconUrl": "https://media.omborigrid.com/media/5f55d979ce0cbb6d30c92c3e/27f54990-0f11-11ec-85ff-7bd005db4d31",
"color": "#987931",
"title": {
"en": "G"
}
}
],
"id": "5387920d-dfdd-4904-8a51-3f007effcffa",
"type": "anonymous",
"queue": "c179a3a2-9fd7-4e12-96e7-19d9e957e094",
"createdAt": "2020-11-17T11:45:57.114Z",
"numberInTheQueue": 6
}
} |