Cyan Web API - Version 1

GET api/devices?{manufacturerDeviceId}

            Gets a device by the ManufacturerDeviceId.  This is an identifier which originates on the device -
            it might be a serial number, hardware identifier, MAC address, or some other type of identifier which
            is intended to uniquely identify the device.
            This field is not guaranteed to be globally unique across all devices, so this method will just return the first matching
            device resource within the request Tenant.  If the client is unable to determine a unique identifier for itself, it
            should attempt to assign itself a unique identifier using a UUID/GUID, or a combination of potentially unique fields.

Request Information

Parameters

Name	Description	Additional information
manufacturerDeviceId		Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "deviceId": "c22754fe-8ece-469d-9f73-405b1b320da9",
  "tenantId": "d85bb437-166c-4e25-a7c4-5ec5476590c3",
  "deviceGroupId": "32423096-22f9-4148-9327-84f40694aa2f",
  "name": "sample string 4",
  "description": "sample string 5",
  "manufacturerDeviceId": "sample string 6",
  "manufacturer": "sample string 7",
  "model": "sample string 8",
  "versionInfo": "sample string 9",
  "phoneNumber": "sample string 10",
  "isBlocked": true,
  "connectedDateUtc": "2025-04-18T11:54:00.1365438+00:00",
  "imei": "sample string 12",
  "macAddress": "sample string 13",
  "serialNumber": "sample string 14",
  "bluetoothName": "sample string 15",
  "createdDateUtc": "2025-04-18T11:54:00.1365438+00:00",
  "updatedDateUtc": "2025-04-18T11:54:00.1365438+00:00"
}

application/xml, text/xml

Sample:

<DeviceRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <CreatedDateUtc>2025-04-18T11:54:00.1365438+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-04-18T11:54:00.1365438+00:00</UpdatedDateUtc>
  <BluetoothName>sample string 15</BluetoothName>
  <ConnectedDateUtc>2025-04-18T11:54:00.1365438+00:00</ConnectedDateUtc>
  <Description>sample string 5</Description>
  <DeviceGroupId>32423096-22f9-4148-9327-84f40694aa2f</DeviceGroupId>
  <DeviceId>c22754fe-8ece-469d-9f73-405b1b320da9</DeviceId>
  <Imei>sample string 12</Imei>
  <IsBlocked>true</IsBlocked>
  <MacAddress>sample string 13</MacAddress>
  <Manufacturer>sample string 7</Manufacturer>
  <ManufacturerDeviceId>sample string 6</ManufacturerDeviceId>
  <Model>sample string 8</Model>
  <Name>sample string 4</Name>
  <PhoneNumber>sample string 10</PhoneNumber>
  <SerialNumber>sample string 14</SerialNumber>
  <TenantId>d85bb437-166c-4e25-a7c4-5ec5476590c3</TenantId>
  <VersionInfo>sample string 9</VersionInfo>
</DeviceRepresentation>