REST API PCSC Objects PCSC READER

April 13, 2023 at 2:39 AM

PCSC_READER object

The JSON PCSC_READER object returns all the technical data regarding a PC/SC reader.

Use List PC/SC readers to retrieve all the PCSC_READER objects, or Get reader data if you already know the readers’s ReaderId.

Object definition

Field name Type Status Description
ReaderId string always The unique identifier of the reader. Use this as {$Id} in all /pcsc/reader/{$id}/* requests
ParentDeviceId string option The unique identifier of the device this reader belongs to (only for SpringCard readers). Use this as {$Id} in /device/{$id} requests
Name string always The complete name of the reader, as it has been assigned by the PC/SC driver and subsystem
SerialNumber string option Serial number of the reader
VendorName string option Name of the reader’s manufacturer
ProductName string option Name of the device
SlotName string option Name of the slot, in case the device is a multi-slot reader
Status string option See Status string table below
ATR string option If there is a card in the reader, the card’s ATR (in hex)
Error boolean always true if the PC/SC subsystem reports the reader as “unavailable” or “ignored”
Present boolean always true if there is a card in the reader
InUse boolean always true if the card has been connected by an application
Owner boolean option true if the connection to the card is owned by a client of the SpringCard Companion Service

Status string

The Status string in the READER object is contructed from the state returned by the PC/SC subsystem, as follow:

Status String Equivalent PC/SC flag(s) Meaning
error IGNORE
UNAVAILABLE		 The reader shall be ignored
The reader is not available
empty EMPTY No card in the reader
present PRESENT There is a card in the reader
present,mute PRESENT and MUTE There is a card, but it has failed to return an ATR
present,in_use PRESENT and INUSE The card has been connected by an application and could be shared
present,in_use,exclusive PRESENT and INUSE and EXCLUSIVE The card has been connected by an application and can’t be shared

Example

{
	"ReaderId": "mvQ5w5-6ZUbGfl76Q6w-lw",
	"ParentDeviceId": "tGEOILzZVpPHP3eYg_EdXA",
	"Name": "SpringCard Prox'N'Roll Contactless 0",
	"SerialNumber": "D59CD763",
	"VendorName": "SpringCard",
	"ProductName": "Prox'N'Roll",
	"SlotName": "Contactless",
	"Status": "present",
	"ATR": "3B8180018080",
	"Error": false,
	"Present": true,
	"InUse": false
}