{"info":{"_postman_id":"681ef0ea-2f28-4bac-9ab4-996f92f3fa9c","name":"RW Link API","description":"

Overview

\n

The RWLink Web API is a simple REST API that allows 3rd party applications to integrate with RFID scanners.

\n

In order to use the this API, you need to have the RWLink application installed on the machine that needs to connect to the RFID scanner. You can download the RWLink application from here and a user guide to the application from here.

\n

Integration Modes

\n

The RWLink supports integration with all the following types of applications:

\n
    \n

  1. Desktop applications (standalone or client-server)

    \n
    2. \n

  2. Web applications

    \n
    3. \n

  3. Desktop applications that are accessed using RDP

    \n
    4. \n
\n

The RWLink settings for RDP applications is different from web applications and desktop applications. These differences define 2 different modes of integration:

\n
    \n

  1. Local

    \n
    2. \n

  2. Cloud

    \n
    3. \n
\n

Local Mode

\n

Typically used by: Desktop and Web applications

\n

API base URL: http://localhost:{port}:

\n

For web applications, if you are using the RWLink in the \"Local\" integration mode, then the APIs must be invoked from the browser-side code.

\n

Cloud Mode

\n

Typically used by: Applications used over RDP

\n

API base URL: https://link.irysgroup.com/irys-web-link/irys/link/

\n

While applications being used over RDP must necessarily be integrated in \"Cloud\" mode, desktop applications and webapplications can be used in either mode. But, \"Local\" mode is the preferred mode of integration.

\n

API Operation

\n

Once the RWLink has been setup, you can invoke the APIs listed in this document, to trigger various RFID actions.

\n

RFID scanning is inherently an asynchronous process, once scanning is triggered, the device will keep asynchrnously broadcasting scanned items until the scanning is stopped

\n

The scanned data can be retrieved in 3 ways:

\n
    \n

  1. Registering a webhook so that you can get realtime scanned data and error data.

    \n
    2. \n

  2. Listening for realtime data over a websocket connection

    \n
    3. \n

  3. An API call to get all the scanned tags since they were last cleared.

    \n
    4. \n
\n

Note: If you are using TE tags then you MUST use the Websocket method of integration.

\n

Webhook Method

\n

In this method, you will need to create your own API endpoint and register it with the RWLink using the \"addWebhook\" API.

\n

Once registered, the RWLink will broadcast realtime scanned data to the registered webhooks. The format of the broadcast will be:

\n
{\n    \"clientID\": \"IRYS_CONSOLE\",\n    \"port\": 0,\n    \"statucCode\": 0,\n    \"statusMessage\": \"SUCCESS\",\n    \"host\": \"00:04:3E:4C:2B:40\",\n    \"tagCount\": 1,\n    \"tags\": [\"313131313131313131313131\"]\n}\n\n
\n
<irysXmlTagResponse>\n   <statusCode>0</statusCode>\n   <statusMessage>Success</statusMessage>\n   <port>0</port>\n   <clientID>IRYS_CONSOLE</clientID>\n   <tags>313131313131313131313131</tags>\n   <tagCount>1</tagCount>\n</irysXmlTagResponse>\n\n
\n

The RWLink will also broadcast events to the webhooks. A sample of such an event is:

\n
{\n    \"name\": \"SLOT\",\n    \"make\": \"FLATBED\",\n    \"macID\": \"192.168.1.102\",\n    \"eventCode\": \"10\",\n    \"description\": \"CONNECTED\"\n}\n\n
\n
<irysXmlEventResponse>\n   <statusCode>0</statusCode>\n   <port>0</port>\n   <clientID>IRYS_CONSOLE</clientID>\n   <host>00:04:3E:4C:2B:40</host>\n   <make>WAND</make>\n   <eventCode>10</eventCode>\n   <description>CONNECTED</description>\n</irysXmlEventResponse>\n\n
\n

Note: A complete list of events and their corresponding codes is mentioned below.

\n

Websocket Method

\n

This is another method for catupring realtime scan data and events. In order to use this method you will need to create a connection to the RWLink websocket at ws://localhost: and then capture realtime scanned data in the Javascript onMessage() callback. (Ref: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/message_event)

\n

When in \"Local\" mode, this is the fastest method of fetching realtime data and hence the preferred method. The scanned information received through this method, includes some additional data about the scan strength of each tag. The scan data format is:

\n
{\n    \"name\": \"DEMO\",\n    \"make\": \"WAND\",\n    \"host\": \"00:04:3E:4C:2C:3A\",\n    \"rssi\": 0,\n    \"timestamp\": \"09-02-2026 17:22:32\",\n    \"tagCount\": 1,\n    \"tags\": [\n        {\n            \"tag\": \"202502100093\",\n            \"rssi\": 0,\n            \"location\": \"DEMO\",\n            \"isTampered\": false\n        }\n    ]\n}\n\n
\n

The event broadcast format is the same as the webhook method above.

\n

Note:
1. This is a lossy connection and once you stop scanning, you should invoke the \"getScannedItems\" API once to ensure that no scanned data was lost over the socket.

\n

API Method

\n

You can invoke the \"getScannedItems\" API every few seconds in a loop to retireve the scanned items. This is a very slow an inefficient way of fetching the scanned data since each time you call the API it will return the complete list of items scanned since the last \"clear\" API call. So if you are scanning thousands of tags, each invocation of this API will take a very long time to return the data.

\n

Also, this method does not return any runtime error information or any of the scanner events.

\n

List of Events

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event nameEvent code
CONNECTED10
DISCONNECTED11
START_SCAN7
STOP_SCAN8
SEARCH5
CLEAR6
POWER_CHANGE9
\n

List of Device Types

\n
    \n

  1. WAND

    \n
    2. \n

  2. SLING (Windows only)

    \n
    3. \n

  3. SLING_2

    \n
    4. \n

  4. PADDLE

    \n
    5. \n

  5. SURFACE_BT (Windows only)

    \n
    6. \n

  6. SURFACE_USB (Windows only)

    \n
    7. \n

  7. SURFACE_MINI (Windows only)

    \n
    8. \n

  8. SURFACE (Mac only)

    \n
    9. \n

  9. SLIM (Windows only)

    \n
    10. \n

  10. RFD90 (Windows only)

    \n
    11. \n

  11. TUNNEL (Windows only)

    \n
    12. \n

  12. FLATBED (Windows only)

    \n
    13. \n

  13. SLOT (Windows only)

    \n
    14. \n
\n

Important Downloads

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ArtifactLink
RWLink Applicationdownoad here
RWLink User Guidedownload here
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"31747342","collectionId":"681ef0ea-2f28-4bac-9ab4-996f92f3fa9c","publishedId":"2s9YkjA3Uh","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"1d4f7b"},"publishDate":"2024-07-15T10:34:32.000Z"},"item":[{"name":"Get Scanners","id":"14d2b9c8-e0c5-4771-b8e4-1df5b3c43a2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5555/scanners?clientID=IRYS_CONSOLE","urlObject":{"path":["scanners"],"host":["http://localhost:5555"],"query":[{"key":"clientID","value":"IRYS_CONSOLE"}],"variable":[]}},"response":[{"id":"f11035c6-a04d-4908-9243-edfc0ba64963","name":"Get Scanners","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://localhost:5555/scanners?clientID=IRYS_CONSOLE","host":["http://localhost:5555"],"path":["scanners"],"query":[{"key":"clientID","value":"IRYS_CONSOLE"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientID\": \"IRYS_CONSOLE\",\n \"port\": 0,\n \"statusCode\": 0,\n \"statusMessage\": \"Success\",\n \"scanners\": [\n {\n \"name\": \"IRYS SCANNER 1\",\n \"host\": \"00:04:3E:4C:2B:40\",\n \"make\": \"WAND\"\n }\n ]\n}"}],"_postman_id":"14d2b9c8-e0c5-4771-b8e4-1df5b3c43a2a"},{"name":"Connect","id":"488d17f9-d73e-4f3b-9ee1-0ca1654b7fd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/connect?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND","description":"

This command establishes a communication channel to the RFID scanner.

\n","urlObject":{"path":["connect"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"},{"description":{"content":"

(Optional) This is the MAC Address or the IP Address of the RFID scanner to be used

\n","type":"text/plain"},"key":"host","value":"00:04:3E:4C:2B:40"},{"description":{"content":"

(Required only if host has been provided) This is the device type and needs to be one out of the list mentioned in the \"Introduction\" section

\n","type":"text/plain"},"key":"make","value":"WAND"}],"variable":[]}},"response":[{"id":"fe18f494-3276-460b-a803-1e60a055dab9","name":"Connect","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/connect?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND","host":["http://localhost:5555"],"path":["connect"],"query":[{"key":"clientID","value":"IRYS_CONSOLE"},{"key":"host","value":"00:04:3E:4C:2B:40"},{"key":"make","value":"WAND"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientID\": \"IRYS_CONSOLE\",\n \"port\": 9000,\n \"statusCode\": 0,\n \"statusMessage\": \"Success\"\n}"}],"_postman_id":"488d17f9-d73e-4f3b-9ee1-0ca1654b7fd3"},{"name":"Disconnect","id":"fdc06c84-26b1-4e06-85f7-fcb51cad019b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/disconnect?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND","description":"

This command closes the communication channel to the RFID scanner.

\n","urlObject":{"path":["disconnect"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"},{"description":{"content":"

(Optional) This is the MAC Address or the IP Address of the RFID scanner to be used

\n","type":"text/plain"},"key":"host","value":"00:04:3E:4C:2B:40"},{"description":{"content":"

(Required only if host has been provided) This is the device type and needs to be one out of the list mentioned in the \"Introduction\" section

\n","type":"text/plain"},"key":"make","value":"WAND"}],"variable":[]}},"response":[{"id":"a7515ac1-da98-44f3-94b4-9bf3e272ed19","name":"Disconnect","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/disconnect?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND","host":["http://localhost:5555"],"path":["disconnect"],"query":[{"key":"clientID","value":"IRYS_CONSOLE"},{"key":"host","value":"00:04:3E:4C:2B:40"},{"key":"make","value":"WAND"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientID\": \"IRYS_CONSOLE\",\n \"port\": 9000,\n \"statusCode\": 0,\n \"statusMessage\": \"Success\"\n}"}],"_postman_id":"fdc06c84-26b1-4e06-85f7-fcb51cad019b"},{"name":"Start Scan","id":"8e22dcc3-89ea-4e23-90be-3e718542ea27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/startScan?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND&power=30&speed=70","description":"

This command triggers the device to start scanning. If the make and host are specified in this command, then scanning will be triggered on that particular device. However, if no host is specified, then scanning will be triggered on all devices that are marked as CONNECTED in the RWLink.

\n","urlObject":{"path":["startScan"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"},{"description":{"content":"

(Optional) This is the MAC Address or the IP Address of the RFID scanner to be used

\n","type":"text/plain"},"key":"host","value":"00:04:3E:4C:2B:40"},{"description":{"content":"

(Required only if host has been provided) This is the device type and needs to be one out of the list mentioned in the \"Introduction\" section

\n","type":"text/plain"},"key":"make","value":"WAND"},{"description":{"content":"

(Optional) This is the power at which the scanner should operate and it ranges from 0 to 30. 0 being the lowest and 30 the highest.

\n","type":"text/plain"},"key":"power","value":"30"},{"description":{"content":"

(Optional) This is the percentage duty-cycle at which the scanner should operate. Its value ranges from 5% to 95% with 70% being the optimal value for achieveing high accuracy while conserving battery.

\n","type":"text/plain"},"key":"speed","value":"70"}],"variable":[]}},"response":[{"id":"1ac3c7cd-906b-4e61-af4a-40f89d4fe703","name":"Start Scan","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/startScan?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND","host":["http://localhost:5555"],"path":["startScan"],"query":[{"key":"clientID","value":"IRYS_CONSOLE"},{"key":"host","value":"00:04:3E:4C:2B:40"},{"key":"make","value":"WAND"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientID\": \"IRYS_CONSOLE\",\n \"port\": 9000,\n \"statusCode\": 0,\n \"statusMessage\": \"Success\"\n}"}],"_postman_id":"8e22dcc3-89ea-4e23-90be-3e718542ea27"},{"name":"Stop Scan","id":"f9a5854f-3669-494d-864d-3d91de1873dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/stopScan?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND","description":"

Use this command to terminate the scanning state of the RFID device.

\n","urlObject":{"path":["stopScan"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"},{"description":{"content":"

(Optional) This is the MAC Address or the IP Address of the RFID scanner to be used

\n","type":"text/plain"},"key":"host","value":"00:04:3E:4C:2B:40"},{"description":{"content":"

(Required only if host has been provided) This is the device type and needs to be one out of the list mentioned in the \"Introduction\" section

\n","type":"text/plain"},"key":"make","value":"WAND"}],"variable":[]}},"response":[{"id":"d1ea351a-2391-4b5f-879b-0aa464559c85","name":"Stop Scan","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/stopScan?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND","host":["http://localhost:5555"],"path":["stopScan"],"query":[{"key":"clientID","value":"IRYS_CONSOLE"},{"key":"host","value":"00:04:3E:4C:2B:40"},{"key":"make","value":"WAND"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientID\": \"IRYS_CONSOLE\",\n \"port\": 9000,\n \"statusCode\": 0,\n \"statusMessage\": \"Success\"\n}"}],"_postman_id":"f9a5854f-3669-494d-864d-3d91de1873dd"},{"name":"Start Search","id":"ff81b833-ef20-4107-8691-17da42c31791","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/search?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND&power=30&speed=70&tags=IRYS001;IRYS002;IRYS003","description":"

This command triggers the device to start searching for the list of tags passed to it.

\n","urlObject":{"path":["search"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"},{"description":{"content":"

(Optional) This is the MAC Address or the IP Address of the RFID scanner to be used

\n","type":"text/plain"},"key":"host","value":"00:04:3E:4C:2B:40"},{"description":{"content":"

(Required only if host has been provided) This is the device type and needs to be one out of the list mentioned in the \"Introduction\" section

\n","type":"text/plain"},"key":"make","value":"WAND"},{"description":{"content":"

(Optional) This is the power at which the scanner should operate and it ranges from 0 to 30. 0 being the lowest and 30 the highest.

\n","type":"text/plain"},"key":"power","value":"30"},{"description":{"content":"

(Optional) This is the percentage duty-cycle at which the scanner should operate. Its value ranges from 5% to 95% with 70% being the optimal value for achieveing high accuracy while conserving battery.

\n","type":"text/plain"},"key":"speed","value":"70"},{"description":{"content":"

Semicolon (;) separated, ASCII encoded RFID Tags list

\n","type":"text/plain"},"key":"tags","value":"IRYS001;IRYS002;IRYS003"}],"variable":[]}},"response":[{"id":"db63d087-5e4f-4f29-8b5f-b77ca75e0b77","name":"Start Search","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/search?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND&power=30&speed=70&tags=IRYS001;IRYS002;IRYS003","host":["http://localhost:5555"],"path":["search"],"query":[{"key":"clientID","value":"IRYS_CONSOLE"},{"key":"host","value":"00:04:3E:4C:2B:40"},{"key":"make","value":"WAND"},{"key":"power","value":"30"},{"key":"speed","value":"70"},{"key":"tags","value":"IRYS001;IRYS002;IRYS003"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientID\": \"IRYS_CONSOLE\",\n \"port\": 9000,\n \"statusCode\": 0,\n \"statusMessage\": \"Success\"\n}"}],"_postman_id":"ff81b833-ef20-4107-8691-17da42c31791"},{"name":"Read","id":"1120f1b4-68d3-4efe-81ad-a4e45a22bae3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/read?clientID=IRYS_CONSOLE&host=192.168.1.101&make=FLATBED&power=30","description":"

This command triggers the device to start searching for the list of tags passed to it.

\n","urlObject":{"path":["read"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"},{"description":{"content":"

(Optional) This is the MAC Address or the IP Address of the RFID scanner to be used

\n","type":"text/plain"},"key":"host","value":"192.168.1.101"},{"description":{"content":"

(Required only if host has been provided) This is the device type and needs to be one out of the list mentioned in the \"Introduction\" section

\n","type":"text/plain"},"key":"make","value":"FLATBED"},{"description":{"content":"

(Optional) This is the power at which the scanner should operate and it ranges from 0 to 30. 0 being the lowest and 30 the highest.

\n","type":"text/plain"},"key":"power","value":"30"}],"variable":[]}},"response":[{"id":"17c4d8d2-1839-4ea9-8920-50f8483fd60d","name":"Read","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/read?clientID=IRYS_CONSOLE&host=192.168.1.101&make=FLATBED&power=33","host":["http://localhost:5555"],"path":["read"],"query":[{"key":"clientID","value":"IRYS_CONSOLE"},{"key":"host","value":"192.168.1.101"},{"key":"make","value":"FLATBED"},{"key":"power","value":"33"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"tagsAdded\": [\n \"IRYS012\",\n \"IRYS058\",\n \"IRYS064\",\n \"IRYS063\",\n \"IRYS074\",\n \"IRYS031\",\n \"IRYS029\",\n \"IRYS066\",\n \"IRYS033\",\n \"IRYS076\",\n \"IRYS065\",\n \"IRYS055\",\n \"IRYS044\",\n \"IRYS008\",\n \"IRYS071\",\n \"IRYS051\",\n \"IRYS046\",\n \"IRYS052\",\n \"IRYS068\",\n \"IRYS011\",\n \"IRYS075\",\n \"IRYS081\",\n \"IRYS097\",\n \"IRYS019\",\n \"IRYS069\"\n ],\n \"tagsRemoved\": [\n \"IRYS018\",\n \"IRYS070\",\n \"IRYS080\",\n \"IRYS016\",\n \"IRYS021\",\n \"IRYS047\",\n \"IRYS020\",\n \"IRYS062\",\n \"IRYS015\",\n \"IRYS079\",\n \"IRYS042\",\n \"IRYS057\",\n \"IRYS032\",\n \"IRYS017\",\n \"IRYS048\",\n \"IRYS039\",\n \"IRYS024\",\n \"IRYS030\",\n \"IRYS072\",\n \"IRYS073\",\n \"IRYS001\",\n \"IRYS007\",\n \"IRYS087\",\n \"IRYS094\"\n ],\n \"tagsPresent\": [\n \"IRYS013\",\n \"IRYS002\",\n \"IRYS089\",\n \"IRYS025\"\n ],\n \"tagsAll\": [\n \"IRYS012\",\n \"IRYS058\",\n \"IRYS064\",\n \"IRYS063\",\n \"IRYS074\",\n \"IRYS031\",\n \"IRYS002\",\n \"IRYS029\",\n \"IRYS066\",\n \"IRYS033\",\n \"IRYS076\",\n \"IRYS065\",\n \"IRYS013\",\n \"IRYS055\",\n \"IRYS044\",\n \"IRYS008\",\n \"IRYS071\",\n \"IRYS051\",\n \"IRYS025\",\n \"IRYS046\",\n \"IRYS052\",\n \"IRYS089\",\n \"IRYS068\",\n \"IRYS011\",\n \"IRYS075\",\n \"IRYS081\",\n \"IRYS097\",\n \"IRYS019\",\n \"IRYS069\"\n ],\n \"name\": \"SLOT\",\n \"make\": \"FLATBED\",\n \"host\": \"192.168.1.101\",\n \"statusCode\": 0,\n \"statusMessage\": \"Success\",\n \"port\": 0,\n \"clientID\": \"IRYS_CONSOLE\"\n}"}],"_postman_id":"1120f1b4-68d3-4efe-81ad-a4e45a22bae3"},{"name":"Get Scanned Items","id":"f7259d54-6e69-40a6-915d-a39a3972c42c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/getScannedItems?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND","description":"

This commands returns the entire list of tags scanned since the last CLEAR command. The tags returned here will be identical to the list of tags being displayed in the RWLink application. This cmmand will always return the full list and NOT just the newly scanned items, which is why call this command in a loop is the least efficient way of fetching scanned data.

\n

Data should be fetched using one of the real-time methods i.e. Webhooks or Web sockets and use this method only once at the time of scan termination, inorder to ensure that no data was lost during realu-time data fetch.

\n","urlObject":{"path":["getScannedItems"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"},{"description":{"content":"

(Optional) This is the MAC Address or the IP Address of the RFID scanner to be used

\n","type":"text/plain"},"key":"host","value":"00:04:3E:4C:2B:40"},{"description":{"content":"

(Required only if host has been provided) This is the device type and needs to be one out of the list mentioned in the \"Introduction\" section

\n","type":"text/plain"},"key":"make","value":"WAND"}],"variable":[]}},"response":[{"id":"068c013c-876e-4c4c-b8c1-2a7ef0242aaf","name":"Get Scanned Items","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/getScannedItems?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND","host":["http://localhost:5555"],"path":["getScannedItems"],"query":[{"key":"clientID","value":"IRYS_CONSOLE"},{"key":"host","value":"00:04:3E:4C:2B:40"},{"key":"make","value":"WAND"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientID\": \"IRYS_CONSOLE\",\n \"port\": 0,\n \"statusCode\": 0,\n \"statusMessage\": \"Success\",\n \"host\": \"00:04:3E:4C:2B:40\",\n \"tagCount\": 3,\n \"tags\": [\"313131313131\", \"313131313132\", \"313131313133\"]\n}"}],"_postman_id":"f7259d54-6e69-40a6-915d-a39a3972c42c"},{"name":"Clear Scanned Items","id":"fa5a1b6a-b0bc-4491-be74-539c1f3cbc2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/clearData?clientID=IRYS_CONSOLE","urlObject":{"path":["clearData"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"}],"variable":[]}},"response":[{"id":"a9141a23-491a-4e33-b10a-c63fbc209173","name":"ClearScanned Items","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/clearScannedItems?clientID=IRYS_CONSOLE","protocol":"http","host":["localhost"],"port":"5555","path":["clearScannedItems"],"query":[{"key":"clientID","value":"IRYS_CONSOLE"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientID\": \"IRYS_CONSOLE\",\n \"port\": 9000,\n \"statusCode\": 0,\n \"statusMessage\": \"Success\"\n}"}],"_postman_id":"fa5a1b6a-b0bc-4491-be74-539c1f3cbc2f"},{"name":"Get Battery","id":"51846f48-2e79-43ae-8f6d-dcb2831a1f77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/getBattery?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND","description":"

This command returns the battery level of the queried device. Please note that this method cannot be called in the middle of scanning.

\n","urlObject":{"path":["getBattery"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"},{"description":{"content":"

This is the MAC Address or the IP Address of the RFID scanner to be used

\n","type":"text/plain"},"key":"host","value":"00:04:3E:4C:2B:40"},{"description":{"content":"

(Required only if host has been provided) This is the device type and needs to be one out of the list mentioned in the \"Introduction\" section

\n","type":"text/plain"},"key":"make","value":"WAND"}],"variable":[]}},"response":[{"id":"89a5a8ab-936f-451a-aa6b-413e7a37f64d","name":"Get Battery","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/getBattery?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND","host":["http://localhost:5555"],"path":["getBattery"],"query":[{"key":"clientID","value":"IRYS_CONSOLE"},{"key":"host","value":"00:04:3E:4C:2B:40"},{"key":"make","value":"WAND"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientID\": \"IRYS_CONSOLE\",\n \"port\": 9000,\n \"statusCode\": 0,\n \"statusMessage\": \"Success\"\n}"}],"_postman_id":"51846f48-2e79-43ae-8f6d-dcb2831a1f77"},{"name":"Add Webhook","id":"82b89439-5f31-4403-87c1-b7244248143a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/addWebhook?clientID=IRYS_CONSOLE&url=http://localhost:5050/handleData&type=json","urlObject":{"path":["addWebhook"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"},{"description":{"content":"

The url to the endpoint that will be handling scan and error data coming from the web link.

\n","type":"text/plain"},"key":"url","value":"http://localhost:5050/handleData"},{"description":{"content":"

[Optional] This defines what the data format should be for the events being published to the webhook. The possible values for this param are xml (default) and json

\n","type":"text/plain"},"key":"type","value":"json"}],"variable":[]}},"response":[{"id":"21a045ff-289f-413f-ac9c-c3ad97e17c30","name":"Add Webhook","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/addWebhook?clientID=IRYS_CONSOLE&url=http://localhost:5050/handleData&tyoe","host":["http://localhost:5555"],"path":["addWebhook"],"query":[{"key":"clientID","value":"IRYS_CONSOLE","description":"This is the identifier that is configured in the RWLink application that is deployed on the local machine."},{"key":"url","value":"http://localhost:5050/handleData","description":"The url to the endpoint that will be handling scan and error data coming from the web link."},{"key":"tyoe","value":null}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientID\": \"IRYS_CONSOLE\",\n \"port\": 9000,\n \"statusCode\": 0,\n \"statusMessage\": \"Success\"\n}"}],"_postman_id":"82b89439-5f31-4403-87c1-b7244248143a"},{"name":"Remove Webhook","id":"2ad039b1-0e8d-4d2a-8c1e-213bc9a194a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/removeWebhook?clientID=IRYS_CONSOLE&url=http://localhost:5050/handleData","urlObject":{"path":["removeWebhook"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"},{"description":{"content":"

The url to the endpoint that will be handling scan and error data coming from the web link.

\n","type":"text/plain"},"key":"url","value":"http://localhost:5050/handleData"}],"variable":[]}},"response":[{"id":"02eb3355-45ae-4243-b069-154b5e286955","name":"Remove Webhook","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/removeWebhook?clientID=IRYS_CONSOLE&url=http://localhost:5050/handleData","host":["http://localhost:5555"],"path":["removeWebhook"],"query":[{"key":"clientID","value":"IRYS_CONSOLE","description":"This is the identifier that is configured in the RWLink application that is deployed on the local machine."},{"key":"url","value":"http://localhost:5050/handleData","description":"The url to the endpoint that will be handling scan and error data coming from the web link."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientID\": \"IRYS_CONSOLE\",\n \"port\": 9000,\n \"statusCode\": 0,\n \"statusMessage\": \"Success\"\n}"}],"_postman_id":"2ad039b1-0e8d-4d2a-8c1e-213bc9a194a5"},{"name":"Write To Tag","id":"84c97551-0670-4e57-ad5e-433885a43e25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/writeData?clientID=IRYS_CONSOLE&host=00043E4C2B40@COM5&make=SLIM&power=25&data=IRYS001","description":"

This command is used to encode a value to the tag. This command can be used only to write to the EPC memory of the tag and can contain a max of 12 bytes of data i.e. a hex string of length 24.

\n","urlObject":{"path":["writeData"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"},{"description":{"content":"

This is the MAC Address or the IP Address of the RFID scanner to be used

\n","type":"text/plain"},"key":"host","value":"00043E4C2B40@COM5"},{"description":{"content":"

This is the device type and needs to be one out of the list mentioned in the \"Introduction\" section

\n","type":"text/plain"},"key":"make","value":"SLIM"},{"description":{"content":"

(Optional) This is the power at which the scanner should operate and it ranges from 0 to 30. 0 being the lowest and 30 the highest.

\n","type":"text/plain"},"key":"power","value":"25"},{"description":{"content":"

ASCII value for the string to be written to the tag. This length of this hex string cannot exceed 16 characters

\n","type":"text/plain"},"key":"data","value":"IRYS001"}],"variable":[]}},"response":[{"id":"d83afb1f-234a-438c-8048-7e24f3542136","name":"Successful write","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/writeData?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND&power=30&data=IRYS001","host":["http://localhost:5555"],"path":["writeData"],"query":[{"key":"clientID","value":"IRYS_CONSOLE","description":"This is the identifier that is configured in the RWLink application that is deployed on the local machine."},{"key":"host","value":"00:04:3E:4C:2B:40","description":"This is the MAC Address or the IP Address of the RFID scanner to be used"},{"key":"make","value":"WAND","description":"This is the MAC Address or the IP Address of the RFID scanner to be used"},{"key":"power","value":"30","description":"(Optional) This is the power at which the scanner should operate and it ranges from 0 to 30. 0 being the lowest and 30 the highest."},{"key":"data","value":"IRYS001","description":"ASCII value for the string to be written to the tag. This length of this hex string cannot exceed 16 characters"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\":0,\n \"statusMessage\":\"Success\",\n \"port\":0,\n \"previousValue\":\"495259533030310000000000\",\n \"newValue\":\"495259533030320000000000\",\n \"timestamp\":\"15-04-2025 14:09:16\",\n \"clientID\":\"IRYS_CONSOLE\"\n}"},{"id":"a1340bf8-9ae1-49da-b3a3-1adbccfba4e4","name":"Unsuccessful write","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/writeData?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND&power=30&data=IRYS001","host":["http://localhost:5555"],"path":["writeData"],"query":[{"key":"clientID","value":"IRYS_CONSOLE","description":"This is the identifier that is configured in the RWLink application that is deployed on the local machine."},{"key":"host","value":"00:04:3E:4C:2B:40","description":"This is the MAC Address or the IP Address of the RFID scanner to be used"},{"key":"make","value":"WAND","description":"This is the MAC Address or the IP Address of the RFID scanner to be used"},{"key":"power","value":"30","description":"(Optional) This is the power at which the scanner should operate and it ranges from 0 to 30. 0 being the lowest and 30 the highest."},{"key":"data","value":"IRYS001","description":"ASCII value for the string to be written to the tag. This length of this hex string cannot exceed 16 characters"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\":-1,\n \"statusMessage\":\"Write to tag failed with reason: Unable to Encode\",\n \"port\":0,\n \"previousValue\":\"\",\n \"newValue\":\"495259533030323334353637\",\n \"timestamp\":\"15-04-2025 14:07:08\",\n \"clientID\":\"IRYS_CONSOLE\"\n}"}],"_postman_id":"84c97551-0670-4e57-ad5e-433885a43e25"},{"name":"Start Scan for Encoder","id":"edcb51ac-b955-494c-9618-de61ae521b3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/writeData/scan?clientID=IRYS_CONSOLE&host=00043E4C2B40@COM5&make=SLIM&power=30&speed=70","description":"

This command is identical to the startScan command, but in case of Fixed Readers like FLATBED, SLOT etc, it will apply the internal encoding RFID properties instead of the standard scanning RFID properties. For non-fixed readers, this command will work the same as the startScan command.

\n","urlObject":{"path":["writeData","scan"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"},{"description":{"content":"

(Optional) This is the MAC Address or the IP Address of the RFID scanner to be used

\n","type":"text/plain"},"key":"host","value":"00043E4C2B40@COM5"},{"description":{"content":"

(Required only if host has been provided) This is the device type and needs to be one out of the list mentioned in the \"Introduction\" section

\n","type":"text/plain"},"key":"make","value":"SLIM"},{"description":{"content":"

(Optional) This is the power at which the scanner should operate and it ranges from 0 to 30. 0 being the lowest and 30 the highest.

\n","type":"text/plain"},"key":"power","value":"30"},{"description":{"content":"

(Optional) This is the percentage duty-cycle at which the scanner should operate. Its value ranges from 5% to 95% with 70% being the optimal value for achieveing high accuracy while conserving battery.

\n","type":"text/plain"},"key":"speed","value":"70"}],"variable":[]}},"response":[{"id":"68761de9-a9d0-4d7e-9666-617a1a23e37b","name":"Start Scan","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/startScan?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND","host":["http://localhost:5555"],"path":["startScan"],"query":[{"key":"clientID","value":"IRYS_CONSOLE"},{"key":"host","value":"00:04:3E:4C:2B:40"},{"key":"make","value":"WAND"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientID\": \"IRYS_CONSOLE\",\n \"port\": 9000,\n \"statusCode\": 0,\n \"statusMessage\": \"Success\"\n}"}],"_postman_id":"edcb51ac-b955-494c-9618-de61ae521b3b"},{"name":"Start Search for Encoder","id":"a75b303b-acbf-44fa-aede-b8a489415098","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:5555/writeData/search?clientID=IRYS_CONSOLE&host=00043E4C2B40@COM5&make=SLIM&power=25&speed=70&tags=IRYS001;IRYS002;IRYS003","description":"

This command is identical to the search command, but in case of Fixed Readers like FLATBED, SLOT etc, it will apply the internal encoding RFID properties instead of the standard searching RFID properties. For non-fixed readers, this command will work the same as the search command.

\n","urlObject":{"path":["writeData","search"],"host":["http://localhost:5555"],"query":[{"description":{"content":"

This is the identifier that is configured in the RWLink application that is deployed on the local machine.

\n","type":"text/plain"},"key":"clientID","value":"IRYS_CONSOLE"},{"description":{"content":"

(Optional) This is the MAC Address or the IP Address of the RFID scanner to be used

\n","type":"text/plain"},"key":"host","value":"00043E4C2B40@COM5"},{"description":{"content":"

(Required only if host has been provided) This is the device type and needs to be one out of the list mentioned in the \"Introduction\" section

\n","type":"text/plain"},"key":"make","value":"SLIM"},{"description":{"content":"

(Optional) This is the power at which the scanner should operate and it ranges from 0 to 30. 0 being the lowest and 30 the highest.

\n","type":"text/plain"},"key":"power","value":"25"},{"description":{"content":"

(Optional) This is the percentage duty-cycle at which the scanner should operate. Its value ranges from 5% to 95% with 70% being the optimal value for achieveing high accuracy while conserving battery.

\n","type":"text/plain"},"key":"speed","value":"70"},{"description":{"content":"

Semicolon (;) separated, ASCII encoded RFID Tags list

\n","type":"text/plain"},"key":"tags","value":"IRYS001;IRYS002;IRYS003"}],"variable":[]}},"response":[{"id":"e8ebcbb3-6b43-412f-90d4-800f72094ff3","name":"Start Search","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"http://localhost:5555/search?clientID=IRYS_CONSOLE&host=00:04:3E:4C:2B:40&make=WAND&power=30&speed=70&tags=IRYS001;IRYS002;IRYS003","host":["http://localhost:5555"],"path":["search"],"query":[{"key":"clientID","value":"IRYS_CONSOLE"},{"key":"host","value":"00:04:3E:4C:2B:40"},{"key":"make","value":"WAND"},{"key":"power","value":"30"},{"key":"speed","value":"70"},{"key":"tags","value":"IRYS001;IRYS002;IRYS003"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientID\": \"IRYS_CONSOLE\",\n \"port\": 9000,\n \"statusCode\": 0,\n \"statusMessage\": \"Success\"\n}"}],"_postman_id":"a75b303b-acbf-44fa-aede-b8a489415098"}],"event":[{"listen":"prerequest","script":{"id":"29e859b1-3a03-424d-bd34-ddafd75a7fec","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e0eccfe4-de6e-4b1d-b821-4a400b7385a7","type":"text/javascript","exec":[""]}}],"variable":[{"key":"hostname","value":"http://localhost:5555","type":"string"}]}