Validate Device

GET

https://app.impiloplatform.com/api/v3/device/validate/:deviceIdentifier

GET

/api/v3/device/validate/:deviceIdentifier

1 curl https://app.impiloplatform.com/api/v3/device/validate/deviceIdentifier \
2      -H "Impilo-API-Key: <apiKey>"

Try it

200validateDeviceResponseExample

1 {
2   "valid": true,
3   "device": {
4     "id": 599,
5     "item": {
6       "id": 791,
7       "manufacturer": {
8         "id": 2,
9         "name": "Custom Manufacturer"
10       },
11       "name": "Blood Pressure Monitor",
12       "model": "iBloodPressureMonitor123",
13       "sku": "0000001",
14       "orderable": true
15     },
16     "currentStatus": "withPatient",
17     "used": true,
18     "currentPatient": {
19       "firstName": "John",
20       "lastName": "Doe",
21       "id": 456,
22       "externalIdentifier": "external-identifier-123",
23       "dateOfBirth": "1987-09-13",
24       "email": "email@example.com",
25       "phoneNumber": "111-222-3333",
26       "archived": true,
27       "address": {
28         "lineOne": "1234 Market Street",
29         "city": "Philadelphia",
30         "state": "PA",
31         "zipCode": "19137",
32         "country": "USA",
33         "lineTwo": "Suite 110"
34       },
35       "site": {
36         "id": 1
37       },
38       "enrolled": true,
39       "sex": "unknown"
40     },
41     "site": {
42       "id": 1,
43       "name": "name",
44       "active": true,
45       "phoneNumber": "phoneNumber",
46       "address": {
47         "lineOne": "lineOne",
48         "city": "city",
49         "state": "state",
50         "zipCode": "zipCode",
51         "country": "country"
52       }
53     },
54     "lastHealthCheck": "lastHealthCheck",
55     "deviceIdentifiers": [
56       {
57         "type": "imei",
58         "value": "354833969951611"
59       },
60       {
61         "type": "serial",
62         "value": "A44-A0623930"
63       },
64       {
65         "type": "macAddress",
66         "value": "f51da43314fc"
67       }
68     ],
69     "deviceEvents": [
70       {}
71     ],
72     "externalIdentifier": "externalIdentifier",
73     "disabledReadings": false
74   }
75 }

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.

validbooleanOptional

A Boolean value of whether this device identifier is validated or not.

deviceobjectOptional

The Device associated with the provided Device Identifier, if exists.

Path parameters

Headers

Response