GetDeviceList

GetDeviceList is used to return a list of devices. The list will be limited to only those devices that the specified user has access to, the devices under the specified entity (partner, company, user ID, or user), and the devices filtered by the specified string. GetDeviceList should be used to navigate through manageable devices. Do not use it to generate reports. GetDeviceList is limited to 100 devices. The equivalent option in the dashboard is the list displayed on the Devices page. You can get a complete list of all devices by clicking Download list on that same page.

Signature

ServiceResponse GetDeviceList (CallingContext callingContext, GetDeviceListInput input, out GetDeviceListResult result);

Data structure

Using GetDeviceList without setting any values will return up to 100 devices that the CallingContext object has access to. If you specify RestrictingEntityId, the returned list, limited by CallingContext, will also be limited to up to 100 devices assigned to the specified entity. If you specify Filter, the returned listed, limited by CallingContext, will also be limited to up to 100 devices that contain the string in one of the returned fields. If you specify both, the returned list will be limited to up to 100 devices and by CallingContext, RestrictingEntityId, and Filter.

[DataContract]
public class GetDeviceListInput
{
    public GetDeviceListInput()
    {
    }

    [DataMember]
    public string Filter;

    [DataMember]
    public Guid RestrictingEntityId;
}

Result

In addition to the BaseServiceResult described in General API structure, GetDeviceListResult is an array of GetDeviceListInfo objects, where each entry is a device.

[DataContract]
public class GetDeviceListResult : BaseServiceResult
{
    public CGetDeviceListResult()
    {
    }

    [DataMember]
    public GetDeviceListInfo[] DeviceList;
}

[DataContract]
public struct EditInfoResultDetails
{
    [DataMember]
    public Guid DeviceId;

    [DataMember]
    public string DeviceName;

    [DataMember]
    public string UserEmail;

    [DataMember]
    public Guid UserId;

    [DataMember]
    public string CompanyName;

    [DataMember]
    public Guid CompanyId;

    [DataMember]
    public string PartnerName;

    [DataMember]
    public Guid PartnerId;

    [DataMember]
    public EntityState State;

    [DataMember]
    public long ClientUsageBytes;

    [DataMember]
    public int StorageQuotaGB;

    [DataMember]
    public DateTime LastBackupUtc;
}