#List devices

#Role

Returns the list of SpringCard devices that are either currently attached to the computer, or bound to the computer.

#Prototype

URL : /devices

Method : GET

URL Params : None

Request data : None

#Success Response

Code : 200 OK

Content : an array of DEVICE objects.

Content example

[
	{
		"Channel": "usb",
		"Name": "SpringCore'18",
		"FriendlyName": "SpringCard Puck",
		"PnpId": "021C3461220102",
		"Profile": "direct",
		"Mode": "pcsc",
		"FriendlyMode": "PC/SC",
		"VendorId": 7220,
		"ProductId": 24866,	
		"VendorName": "SpringCard",
		"ProductName": "Puck",
		"ProductVariant": "One",
		"SerialNumber": "24F11E2E",
		"Version": "1.02",
		"Firmware": "SpringCore/H518/Puck",
		"UniqueId": "72967A11-6089-8B0D-F36E-9ED0CC493BE4",
		"ConfigId": "80B4667D-71D0-0BDC-AA81-95DCA20A44E1",
		"Pcsc": {
			"Names": [
				"SpringCard Puck Contactless 0",
				"SpringCard Puck SAM 0"
			],
			"ReaderIds": [
				"9vuhz76cguwt7zn7fk4w2mvdma",
				"a6b2gs7ecvkm8c97evpi3ibhde"
			]
		},
		"SealSubject": "C=FR,ST=Ile-de-France,O=SpringCard,OU=SpringCore,CN=72967A11-6089-8B0D-F36E-9ED0CC493BE4",
		"SealSignature": "WH0g5POUphEVpCmdb/cK8c7X+bgVQ0tQfVzlB8Q4br8Q0Fnvw6/OaZMENbAaH6UxFgSwuV1FLn1WrPLgq1p8DT0ps93d6PuGrIf3YMRzGK6HI6d9Or5GICJ5c/wNSJtEhhSCacYxrAznzhjkYoDPqSvyM1+DdZZIuK3SBDcaBJbi4exmKt1LaU8+nihZ3O6zxOuWQUjtv+6rmCnUd0XtP4reJcKS+RMoMCLypzM+3EXN2VUowwjtiEtULy6MJRe7CDNrWhEo7rzl2NPt1JzPqlELD4Y1Fi1jqUvoKd69i7RJTKqEkjZHtxJtEZGe1+gCum60aHUfAYvbHHvDrmewCw==",
		"Genuine": true,
		"DeviceId": "vkYkoELRDS3p9xhQO1lx8a",
		"Binding": "pnp",
		"Status": "ok"
	},
	{
		"Channel": "usb",
		"Name": "USB input device",
		"FriendlyName": "SpringCard RFID Scanner",
		"Profile": "hid",
		"Mode": "rfidscanner",
		"FriendlyMode": "RDR (RFID Scanner)",
		"VendorId": 7220,
		"ProductId": 29249,
		"PnpId": "021C3492410179",
		"SerialNumber": "82C7995D",
		"Version": "1.79",
		"HidInstance": "hid#vid_1c34&pid_9241#7&3482e2d5&0&0000",
		"DeviceId": "z1FyhlpOKF72WuAdurpwaa",
		"Binding": "pnp",
		"Status": "ok"		
	},
	{
		"Channel": "serial",
		"DeviceId": "UKkLhsqovS4dCKBSc0v799",
		"Binding": "bound",
		"Status": "missing",
		"SerialPort": "COM4"		
	}
]

#Understanding the state of the device

Fields Binding and Status reflect the state of the device.

Please refer to this table for a complete understanding:

#Working with non-PNP devices

status=missing denotes a device that has been associated (bound) to the computer, but that is currently not available. In this situation,

• all the optional fields of the DEVICE object are absent; the object contains only the minimal information the Service needs to find the device (or a suitable device on the same communication channel),
• the only method that could be invoked for the non-PNP device is Unbind Device; other methods are disabled.

status=ok and binding=not-bound denotes a device that has been found by the Lookup method. The device is available, but is not associated (bound) to the computer. This means that the device will not be reconnected automatically when the SpringCard Companion Service (or the computer) restarts. In the situation,

• the DEVICE object is populated with all available values,
• all device-related methods are enabled,
• a persistent binding between the device and the computer may be created by using Bind Device.

status=ok and binding=bound denotes a device that is non-PNP, available, and associated (bound) to the computer. In the situation,

• the DEVICE object is populated with all available values,
• all device-related methods are enabled,
• the persistent binding between the device and the computer may be destroyed by using Unbind Device.

#Error Response

See Error Responses.