API Reference: Devices

Devices within BloodCOMM are cloud-enabled devices that report their data to the BloodCOMM cloud. This endpoint does not require that the devices have active subscriptions, as it is used to determine which devices are valid.

Data is returned in the following format:

Serial Number:

• Unique identifying serial number for this device
• May not be unique between different products, if used as a keying value, use in conjunction with the device type.

Device Type:

• Product type code, to be used for device queries in conjunction with the serial number.

Nickname:

• Optional nickname for the device, able to be set by users.

Teams:

• Optional list of Teams, each as 32 digit UUID strings, for use with the Teams API.
• Users who are assigned to the same team as this device are able to see the device in BloodCOMM, as well as admins.

License:

• Current license assigned to the device.
• Licenses are managed by BloodCOMM Support, only the following device licenses are able to be used for further queries:
  • PRO or PRO_TRIAL
  • PREMIUM or PREMIUM_TRIAL
• The following licenses types will result in an error or no data being returned by further queries:
  • NONE or EXPIRED

There are no differences in access or available data between regular and trial licenses. Note that devices are unable to be assigned ENTERPRISE licenses, so your ENTERPRISE subscription will come with either PRO or PREMIUM licenses for the individual devices.

Expiration Date:

• The timestamp (in seconds since epoch) when the current license expires.
• If the device has a valid license, this will be the date when that license expires.
• If the license is expired or not assigned, this value will be 0.
• If the device is not able to be assigned a license (e.g. accessories), this value will be -1.

/devices

Get a list of all devices for this organization.

Response:

This request will return all registered cloud devices, including those that are not currently active or those which do not have a valid subscription.

[
    {
        "serial": <string>,
        "type": <string>,
        "license": <string>,
        "expiration": <number>,
        "nickname": <string>,
        "teams":[<string>]
    },
    {
        "serial": "1ABCD2",
        "type": "APRU-006L",
        "license": "PRO_TRIAL",
        "expiration": 1735689600,
        "nickname": "",
        "teams":[]
    },
    ...
]

/devices/<DEVICE_TYPE>/<SERIAL_NUMBER>

Get a list of all devices for this organization.

Response:

This request will return any registered devices, including those that are not currently active or those which do not have a valid subscription.

{
    "serial": <string>,
    "type": <string>,
    "license": <string>,
    "expiration": <number>,
    "nickname": <string>,
    "teams":[<string>]
}