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.

validbooleanOptional

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

deviceobjectOptional

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

GET

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

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       "address": {
22         "lineOne": "1234 Market Street",
23         "city": "Philadelphia",
24         "state": "PA",
25         "zipCode": "19137",
26         "country": "USA",
27         "lineTwo": "Suite 110"
28       },
29       "id": 456,
30       "externalIdentifier": "external-identifier-123",
31       "dateOfBirth": "1987-09-13",
32       "email": "email@example.com",
33       "phoneNumber": "111-222-3333",
34       "archived": true,
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       "address": {
46         "lineOne": "lineOne",
47         "city": "city",
48         "state": "state",
49         "zipCode": "zipCode",
50         "country": "country"
51       }
52     },
53     "lastHealthCheck": "lastHealthCheck",
54     "deviceIdentifiers": [
55       {
56         "type": "imei",
57         "value": "354833969951611"
58       },
59       {
60         "type": "serial",
61         "value": "A44-A0623930"
62       },
63       {
64         "type": "macAddress",
65         "value": "f51da43314fc"
66       }
67     ],
68     "deviceEvents": [
69       {}
70     ],
71     "externalIdentifier": "externalIdentifier",
72     "disabledReadings": false
73   }
74 }

Built with

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

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	"address": {
22	"lineOne": "1234 Market Street",
23	"city": "Philadelphia",
24	"state": "PA",
25	"zipCode": "19137",
26	"country": "USA",
27	"lineTwo": "Suite 110"
28	},
29	"id": 456,
30	"externalIdentifier": "external-identifier-123",
31	"dateOfBirth": "1987-09-13",
32	"email": "email@example.com",
33	"phoneNumber": "111-222-3333",
34	"archived": true,
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	"address": {
46	"lineOne": "lineOne",
47	"city": "city",
48	"state": "state",
49	"zipCode": "zipCode",
50	"country": "country"
51	}
52	},
53	"lastHealthCheck": "lastHealthCheck",
54	"deviceIdentifiers": [
55	{
56	"type": "imei",
57	"value": "354833969951611"
58	},
59	{
60	"type": "serial",
61	"value": "A44-A0623930"
62	},
63	{
64	"type": "macAddress",
65	"value": "f51da43314fc"
66	}
67	],
68	"deviceEvents": [
69	{}
70	],
71	"externalIdentifier": "externalIdentifier",
72	"disabledReadings": false
73	}
74	}