GET api/v1/healthprofessional/devices?PatientId={PatientId}&DeviceTypeId={DeviceTypeId}&Id={Id}&Status={Status}

Gets a collection of devices, filtered with the query.

Request Information

Headers

URI Parameters

Name	Description	Type	Additional information
PatientId	{Optional} - The patient identifier	string	None.
DeviceTypeId	{Optional} - The type identifier for the device	DeviceType	None.
Id	{Optional} - The identifier for the device	string	None.
Status	{Optional} - The status for the device	DeviceStatus	None.

Body Parameters

None.

Response Information

Headers

Resource Description

Collection of Device

Name	Description	Type	Additional information
Id	The identifier for the device.	string	None.
TypeId	The type identifier for the device	DeviceType	Required
EquipmentId	The equipment identifier, Bluetooth/ZigBee address or other identifier.	string	Required
AcquisitionDate	The acquisition date of the device	date	Required
Status	The status of the device, allocated or deallocated.	DeviceStatus	Required
Manufacturer	{Optional} - The manufacturer for the device	string	None.
Model	{Optional} - Model of the device	string	None.
SerialNumber	{Optional} - The serial number for the device	string	None.
PatientId	{Optional} - The patient identifier mapped to the device	string	None.
LatestSync	{Optional} - The latest synchronize of the device to the server.	date	None.

Response Formats

application/json

Sample:

[
  {
    "Id": "sample string 1",
    "TypeId": 528388,
    "EquipmentId": "sample string 3",
    "AcquisitionDate": "2025-11-27T17:13:40.5233358+00:00",
    "Status": "Allocated",
    "Manufacturer": "sample string 4",
    "Model": "sample string 5",
    "SerialNumber": "sample string 6",
    "PatientId": "sample string 7",
    "LatestSync": "2025-11-27T17:13:40.5233358+00:00"
  },
  {
    "Id": "sample string 1",
    "TypeId": 528388,
    "EquipmentId": "sample string 3",
    "AcquisitionDate": "2025-11-27T17:13:40.5233358+00:00",
    "Status": "Allocated",
    "Manufacturer": "sample string 4",
    "Model": "sample string 5",
    "SerialNumber": "sample string 6",
    "PatientId": "sample string 7",
    "LatestSync": "2025-11-27T17:13:40.5233358+00:00"
  }
]