MobileDeviceServicesGetDeviceCandidates Method Ingeniux CMS Web Services API
Retrieves Mobile Devices listing, that matches search criteria, from Mobile Device library.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)
Syntax
Copy
public XHRServiceResponseGeneric<DeviceListResponse> GetDeviceCandidates(
	DeviceListingFilter data
)

Parameters

data
Type: DeviceListingFilter

Criteria to generate the listing. Because there are 50,000 devices and growing, the result will provided in paginated fashion.

Examples
Sample JSON input
JavaScript
Copy
{
    "data": {
        "ExcludeIds": ["18736-18111-24178-18092", 
            "18736-18111-24343-18092"],
        "Manufacturer": "HTC",
        "Width": 480,
        "Height": 800,
        "NameFilter": "HTC one",
        "start": 200,
        "count": 100
    }
}

Return Value

Type: XHRServiceResponseGenericDeviceListResponse

Listing of Devices matching the search criteria, and the list count

Examples
Sample JSON return
JavaScript
Copy
{
    "code": 0,
    "error": null,
    "message": {
        "Devices": [{
            "FullName": "HTC - One SU (Android 4.2)",
            "Height": 800,
            "ID": "20294-18111-22589-18092",
            "IsTablet": false,
            "Manufacturer": "HTC",
            "Platform": "Android",
            "UserAgent": "Mozilla\/5.0 (Linux; U; Android 4.1.1; zh-cn; HTC T528w Build\/JRO03H) AppleWebKit\/533.1 (KHTML, like Gecko)Version\/4.0 MQQBrowser\/4.2 Mobile Safari\/533.1",
            "Version": "4.2",
            "Width": 480
        }, {
            "FullName": "HTC - One SU (Android 4.3)",
            "Height": 800,
            "ID": "20294-18111-22879-18092",
            "IsTablet": false,
            "Manufacturer": "HTC",
            "Platform": "Android",
            "UserAgent": "Mozilla\/5.0 (Linux; U; Android 4.1.1; zh-cn; HTC T528w Build\/JRO03H) AppleWebKit\/533.1 (KHTML, like Gecko)Version\/4.0 MQQBrowser\/4.3 Mobile Safari\/533.1",
            "Version": "4.3",
            "Width": 480
        }, {
            "FullName": "HTC - One SU (Android 4.5)",
            "Height": 800,
            "ID": "20294-18111-24683-18092",
            "IsTablet": false,
            "Manufacturer": "HTC",
            "Platform": "Android",
            "UserAgent": "Mozilla\/5.0 (Linux; U; Android 4.1.1; zh-cn; HTC T528w Build\/JRO03H) AppleWebKit\/533.1 (KHTML, like Gecko)Version\/4.0 MQQBrowser\/4.5 Mobile Safari\/533.1",
            "Version": "4.5",
            "Width": 480
        }, {
            "FullName": "HTC - One SU (Android 9.0)",
            "Height": 800,
            "ID": "20294-18111-22261-18092",
            "IsTablet": false,
            "Manufacturer": "HTC",
            "Platform": "Android",
            "UserAgent": "Mozilla\/5.0 (Linux; U; Android 4.1.1; zh-CN; HTC T528w Build\/JRO03H) AppleWebKit\/534.31 (KHTML, like Gecko) UCBrowser\/9.0.1.294 U3\/0.8.0 Mobile Safari\/534.31",
            "Version": "9.0",
            "Width": 480
        }],
        "TotalCount": 248
    }
}
See Also

Reference

MobileDeviceServices Class
IngeniuxCMService Namespace