Badge Dispenser

The badge dispenser device has the ability to issue and accept cards. Any data can be written to and read from the card. The badge dispenser can pull cards in to the reader level, and then either return them or drop them down. It can also issue a card from the set of cards, read its id, and issue it to the customer.

Below are the main endpoints that you can use to communicate with the device:

Get Status

Retrieves the current status of the device.

GET /status

Response:

{
  "status": "ok",
  "version": "Simulator",
  "available": true,
  "initializing": false,
  "warning": false,
  "error": false,
  "deviceSpecificStatus": {
    "retractBinNearFullCountMax": 1,
    "retractBinFullCountMax": 3,
    "retractBinNearFull": false,
    "retractBinFull": false,
    "containerFilling": 0,
    "badgesNearEnd": true,
    "outOfBadges": false,
    "badgePresented": false,
    "badgeRetracted": true,
    "retractionActivated": true,
    "busyProcessing": false
  },
  "reasons": [],
  "brokerUrl": "mqtt://localhost",
  "mqttConnectionState": "error",
  "readCard": "22057100676"
}

Dispense

Request to start dispensing a new RFID card

POST /dispense

Headers:

{
    "Content-Type": "application/json",
}

Request body can be empty

Activate Retraction

Request to wait for a RFID card to read. It will try to read a RFID card, if it is possible and then will wait for a next request as to whether the RFID card to be collected or ejected

POST /activate-retraction

Headers:

{
    "Content-Type": "application/json",
}

Request body can be empty

Deactivate retraction

Request to stop wait for a RFID card to read

POST /deactivate-retraction

Headers:

{
    "Content-Type": "application/json",
}

Request body can be empty

Eject

Request to start eject a RFID card, that was in the read position

POST /eject

Headers:

{
    "Content-Type": "application/json",
}

Request body can be empty

Collect

Request to start to collect a RFID card, that is in the read position

POST /collect

Headers:

{
    "Content-Type": "application/json",
}

Request body can be empty

Clear Retract Bin

Request for reset retract bin count

POST /clear-retract-bin

Headers:

{
    "Content-Type": "application/json",
}

Request body can be empty