Get main data

These endpoints collect main data from the server.

📄️Get dispenser

This endpoint returns the dispenser entity based on the presented Websocket ID in the X-WSID header.

📄️Get branch

This request return the branch entity by the device.

📄️Get languages

This endpoint returns all active language entities.

📄️Get a language by key

This endpoint returns the language entity by key.

📄️Get locales

This request returns the language texts for localization.

📄️Get settings

This endpoint returns the dispenser settings. It contains Smart Ticket & styling settings.

📄️Get services

This endpoint returns the list of active services which are assigned to the branch of dispenser.

📄️Get service groups

This endpoint returns the list of active service groups.

📄️Get profile

This endpoint returns the Ticket Dispenser Profile entity by key. You have to choose the correct profile key based on the profile scheduling of dispenser entity in "Get Dispenser" response.

📄️Get alarm status

Call this endpoint to get the alarm status.

📄️Get waiting info

This endpoint returns the waiting info by services in the branch.

📄️Get exception day

This endpoint returns the exception day of today. The weekday means the type of exception.

📄️Get Smart Ticket QR code

This endpoint returns the Smart Ticket QR code as a PNG image. It's a dynamic QR code, you should recall it to get a fresh one before the expiration. The expiration is in the validityTime property in the settings response.

📄️Get selectable clerks

This endpoint returns the logged in clerks for clerk selection feature. To get the list, you should set the language key and service key parameters.

📄️Get visible services

This endpoint returns the list of visible services of profile.