GET Remote Reader API
  1. General
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. General

Cancel an active job

GET
/api/cancel/v5/{id}
Cancel an active job using its unique identifier (UUID).

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

Responses

🟢202Accepted
Job successfully cancelled
This response does not have a body.
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🟠405405
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://192-168-1-1.xip.get.systems:9443/api/cancel/v5/12345678-abcd-4bcf-9bcd-123456789012' \
--header 'Authorization: Basic <encoded-value>'
Response Response Example
400 - Example 1
{
    "errorCode": "BadRequest",
    "errorMessage": "string"
}
Modified at 2025-02-13 14:31:55
Previous
Get the configuration of the device
Next
Get the status of an asynchronous display operation on the device's screen (UI related)
Built with