Before stop session

GET{{server}}/api/v1/counter/session/beforeStop

You can check if there are any waiting tickets, redirected tickets or tickets on waitlist for the clerk. This endpoint returns these values and you can show a confirmation dialog on the counter before stopping the session.

Response

• local (number): The number of tickets on clerk's local waitlist.

• redirected (number): The number of redirected tickets to the clerk.

• wait (number): The number of waiting tickets what can be handled by this clerk only.

Request

Authorization

Header	Value
Authorization	Bearer {{counterToken}}

Headers

Key	Value
Accept	application/json
X-WSID	{{counterWsID}}

Code snippets

cURL

curl -X GET '{{server}}/api/v1/counter/session/beforeStop' \
  -H 'Accept: application/json' \
  -H 'X-WSID: {{counterWsID}}' \
  -H 'Authorization: Bearer {{counterToken}}'

JavaScript

const response = await fetch("{{server}}/api/v1/counter/session/beforeStop", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-WSID": "{{counterWsID}}",
    "Authorization": "Bearer {{counterToken}}"
  },
});

const data = await response.json();
console.log(data);

Python

import requests

url = "{{server}}/api/v1/counter/session/beforeStop"
headers = {
    "Accept": "application/json",
    "X-WSID": "{{counterWsID}}",
    "Authorization": "Bearer {{counterToken}}"
}

response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())

Example

Example request

GET{{server}}/api/v1/counter/session/beforeStop

Headers (2)

Key	Value
Accept	application/json
X-WSID	{{counterWsID}}

Example response 200 Ok

Response headers (9)

Key	Value
Access-Control-Expose-Headers	*
Cache-Control	no-store, no-cache, must-revalidate
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	POST, PUT, GET, OPTIONS, DELETE
Access-Control-Allow-Credentials	true
Content-Length	35
Access-Control-Max-Age	86400
Access-Control-Allow-Headers	Content-Type, Authorization, X-Requested-With
Content-Type	application/json;charset=utf-8

Body

{
  "local": 0,
  "redirected": 0,
  "wait": 0
}