GET Remote Reader API
  1. Ticketing
GET Remote Reader API
  • Basic Information
  • General
    • Get the configuration of the device
      GET
    • Cancel an active job
      GET
  • Status
    • Get the status of an asynchronous display operation on the device's screen (UI related)
      GET
    • Get the status of an asynchronous NFC tag interaction (NFC related)
      GET
  • POS
    • Start a job for a purchase
      POST
    • Initiate a refund job for a specific purchase
      POST
  • Ticketing
    • Start a job to swap a ticket to a NFC-tag
      POST
  • Display
    • Start a job to show information and interactive buttons on the device's UI
      POST
  • TagInfo
    • Start a job that prompts the end-user to scan an NFC tag
      POST
  1. Ticketing

Start a job to swap a ticket to a NFC-tag

POST
/api/ticketing/v5/{id}
Start a job to swap a ticket to a NFC-tag. The ticket may be provided as either a barcode or a JWT.

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Path Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Ticket-Swap job successfully created
Body

🟠400Bad Request
🟠401Unauthorized
🟠405405
🟠409409
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://192-168-1-1.xip.get.systems:9443/api/ticketing/v5/12345678-abcd-4bcf-9bcd-123456789012' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ticketBarcode": "Z9VUEMWMCTVYC4F",
    "title": "Tap a new chip on the reader below to swap the ticket",
    "detail": "Ticket-Barcode: Z9VUEMWMCTVYC4F // Name of the person: Max Mustermann",
    "allowUserCancel": true
}'
Response Response Example
200 - Example 1
{
    "data": {
        "statusUrl": "string",
        "cancellationUrl": "string"
    }
}
Modified at 2025-02-13 14:31:55
Previous
Initiate a refund job for a specific purchase
Next
Start a job to show information and interactive buttons on the device's UI
Built with