Equipment

Equipment refers to sensors, phones and charging stations provisioned to a subject in a remote setting. These endpoints can be used to track hardware inventory throughout the course of a study.

Get Equipment

Get a list of all equipment ever provisioned to a subject in a remote setting.

URL

GET https://mc10cloud.com/api/v1/studies/{studyId}/subjects/{subjectId}/equipment

Parameters

  • studyId: Study UUID

  • subjectId: Subject UUID

Sample Response

The following example shows five pieces of equipment provisioned to a subject. The property id refers to the device serial number.

The last item shows diagnostic information related to an equipment "fault." (This information is also received by MC10.)

{
"items": [
{
"faults": [],
"id": "LXQUXLW8",
"state": "ASSIGNED",
"type": "LINK_HUB"
},
{
"faults": [],
"id": "355022075128632",
"state": "ASSIGNED",
"type": "LINK_PHONE"
},
{
"faults": [],
"id": "M1Z05LWV",
"state": "ASSIGNED",
"type": "SENSOR"
},
{
"faults": [],
"id": "LXQUPOFP",
"state": "ASSIGNED",
"type": "SENSOR"
},
{
"faults": [
{
"createdTs": 1495051405350,
"faultFlag": "0",
"faultTs": 1495051404960,
"faultType": "LINK_HUB_SENSOR_FAULT",
"mobileAppVersion": "RCLinkApp_v0.4.20_42099",
"sensorFirmwareId": "v0-1493-g87e010ac",
"sensorId": "ec:68:31:a2:fc:e0",
...
}
],
"id": "M1Z05LXP",
"state": "UNASSIGNED",
"type": "SENSOR"
}
],
"size": 5
}

Get Equipment Log

Get the provisioning history of a piece of equipment used in a remote setting (across studies).

URL

GET https://mc10cloud.com/api/v1/accounts/{accountId}/equipment/{equipmentId}/history

Parameters

  • accountId: Account UUID

  • equipmentId: Equipment serial number

Sample Response

The following example shows a sensor with serial number LXQUPODN being provisioned to subject S35 in study "MC10-PTL-101", then de-provisioned, then provisioned to subject S01 in "MC10-PTL-102".

{
"items": [
{
"createdTs": 1502993411449,
"id": "LXQUPODN",
"state": "ASSIGNED",
"study": {
"displayName": "MC10-PTL-101",
"id": "ea6eac60-73a1-11e7-a5b3-0a84ea04a300"
},
"subject": {
"displayName": "S35",
"id": "d5e9a180-8375-11e7-9d04-028eb5a65596"
}
},
{
"createdTs": 1527883949268,
"id": "LXQUPODN",
"state": "UNASSIGNED",
"study": {
"displayName": "MC10-PTL-101",
"id": "ea6eac60-73a1-11e7-a5b3-0a84ea04a300"
},
"subject": {
"displayName": "S35",
"id": "d5e9a180-8375-11e7-9d04-028eb5a65596"
}
},
{
"createdTs": 1556821464453,
"id": "LXQUPODN",
"state": "ASSIGNED",
"study": {
"displayName": "MC10-PTL-102",
"id": "3213d920-468f-11e9-98d1-c23a677524f2"
},
"subject": {
"displayName": "S01",
"id": "ab429360-7885-11e7-90ec-0a84ea04a300"
}
},
],
"size": 3
}

Get Equipment Fault Stats

Get fault statistics for equipment provisioned to subjects in a remote setting.

URL

GET https://mc10cloud.com/api/v1/studies/{studyId}/fault_stats

Parameters

  • studyId: Study UUID

Sample Response

The following example shows a total of three equipment faults for two subjects.

{
"items": [
{
"countFaults": 1,
"subjectId": "020e74b0-3a61-11e7-8c2f-0a2e9e9dd655"
},
{
"countFaults": 2,
"subjectId": "0aa0b4e0-3bf5-11e7-8c2f-0a2e9e9dd655"
}
],
"size": 2
}