Devices

Validate Device

GET
This endpoint validates that a Device Identifier exists and returns the Device upon matching. On failure, it indicates that the Identifier is not valid.

Path parameters

deviceIdentifierstringRequired

Response

This endpoint returns an object
valid
booleanOptional
A Boolean value of whether this device identifier is validated or not.
device
objectOptional
The Device associated with the provided Device Identifier, if exists.
GET
1curl https://app.impiloplatform.com/api/v3/device/validate/deviceIdentifier \
2     -H "Impilo-API-Key: <apiKey>"
200
Retrieved
1{
2  "valid": true,
3  "device": {
4    "id": 3,
5    "item": {
6      "id": 1,
7      "manufacturer": {
8        "id": 2,
9        "name": "Custom Manufacturer"
10      },
11      "name": "Blood Pressure Monitor",
12      "model": "iBloodPressureMonitor123",
13      "sku": "0000001"
14    },
15    "currentStatus": "withPatient",
16    "used": true,
17    "currentPatient": {
18      "id": 456,
19      "externalIdentifier": "external-identifier-123",
20      "firstName": "John",
21      "lastName": "Doe",
22      "dateOfBirth": "01-01-2000",
23      "email": "email@example.com",
24      "phoneNumber": "111-222-3333",
25      "archived": true,
26      "address": {
27        "lineOne": "1234 Market Street",
28        "lineTwo": "Suite 110",
29        "city": "Philadelphia",
30        "state": "PA",
31        "zipCode": "19137",
32        "country": "USA"
33      },
34      "site": {
35        "id": 1
36      },
37      "enrolled": true,
38      "sex": "unknown"
39    },
40    "site": {
41      "id": 1,
42      "name": "name",
43      "active": true
44    },
45    "lastHealthCheck": "lastHealthCheck",
46    "deviceIdentifiers": [
47      {
48        "type": "serial",
49        "value": "abc"
50      }
51    ],
52    "deviceEvents": [
53      {}
54    ],
55    "externalIdentifier": "externalIdentifier"
56  }
57}
Built with