Validate Device

GET

/api/v3/device/validate/:deviceIdentifier

GET

/api/v3/device/validate/:deviceIdentifier

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

Try it

200validateDeviceExample

1 {
2   "device": {
3     "currentPatient": {
4       "firstName": "John",
5       "lastName": "Doe",
6       "address": {
7         "city": "foo",
8         "country": "foo",
9         "lineOne": "foo",
10         "state": "foo",
11         "zipCode": "foo",
12         "lineThree": "foo",
13         "lineTwo": "foo",
14         "note": "foo"
15       },
16       "archived": true,
17       "dateOfBirth": "1980-01-01",
18       "email": "john.doe@example.com",
19       "enrolled": true,
20       "externalIdentifier": "1234abcd",
21       "id": 1,
22       "phoneNumber": "+1234567890",
23       "sex": "unknown",
24       "site": {
25         "active": true,
26         "address": {
27           "city": "foo",
28           "country": "foo",
29           "lineOne": "foo",
30           "state": "foo",
31           "zipCode": "foo",
32           "lineThree": "foo",
33           "lineTwo": "foo",
34           "note": "foo"
35         },
36         "id": 1,
37         "name": "foo",
38         "phoneNumber": "foo"
39       }
40     },
41     "currentStatus": "foo",
42     "deviceEvents": [
43       {
44         "eventTimestamp": "foo",
45         "type": "foo"
46       }
47     ],
48     "deviceIdentifiers": [
49       {
50         "type": "foo",
51         "value": "foo"
52       }
53     ],
54     "disabledReadings": false,
55     "externalIdentifier": "1d23-4567-89ab-cdef",
56     "id": 1,
57     "item": {
58       "id": 1,
59       "manufacturer": {
60         "id": 1,
61         "name": "foo"
62       },
63       "model": "foo",
64       "name": "foo",
65       "orderable": true,
66       "sku": "foo"
67     },
68     "lastHealthCheck": "2023-10-01T12:00:00Z",
69     "site": {
70       "active": true,
71       "address": {
72         "city": "foo",
73         "country": "foo",
74         "lineOne": "foo",
75         "state": "foo",
76         "zipCode": "foo",
77         "lineThree": "foo",
78         "lineTwo": "foo",
79         "note": "foo"
80       },
81       "id": 1,
82       "name": "foo",
83       "phoneNumber": "foo"
84     },
85     "used": true
86   },
87   "valid": true
88 }

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

deviceobjectOptional

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

validbooleanOptional

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

Path parameters

Headers

Response