Get device settings - iOS only

This API returns values for data roaming and personal hotspot received on the last device check in. If you would like the most up to date value, then include a Force checkin call in your work-flow. The supported settings are:

•Personal hotspot

•Data roaming

HTTP Method

POST

Request URI

/msa/v1/cps/device/getDeviceSettings

Request parameters

Parameter

Description

Sample Value

identifiers

Required

Parameter Type: Request body

Data Type: String

List of UEM identifiers in this format:

{

"identifiers":["mdm-id-1", "mdm-id-2"]

}

See List of identifiers.

 

{
    "settingsType": "DATA_ROAMING", 
    "identifiers": [
        "b9a0d7d05fb4204f52264f805932526b848ca61d", 
        "a9a0d7d05fb4204f52264f805932526b848ca61d"
    ]
}

settingsType

Required

Parameter Type: Request body

Data Type: String

The settings to retieve. Can be:

•PERSONAL_HOTSPOT

•DATA_ROAMING

 
{
    "settingsType": "DATA_ROAMING", 
    "identifiers": [
        "b9a0d7d05fb4204f52264f805932526b848ca61d", 
        "a9a0d7d05fb4204f52264f805932526b848ca61d"
    ]
}

Response fields

API returns the count of devices for which attributes were successfully updated along with HTTP status 200.

See Number result.

Example request

POST /msa/v1/cps/device/settings
{
    "settingsType": "DATA_ROAMING", 
    "identifiers": [
        "b9a0d7d05fb4204f52264f805932526b848ca61d", 
        "a9a0d7d05fb4204f52264f805932526b848ca61d"
    ]
}

Example response

{
    "settings": [
        {
            "identifier": "b9a0d7d05fb4204f52264f805932526b848ca61d", 
            "settings": {
                "type": "DATA_ROAMING", 
                "value": {
                    "enabled": false
                }
            }
        }, 
        {
            "identifier": "a9a0d7d05fb4204f52264f805932526b848ca61d", 
            "settings": {
                "type": "DATA_ROAMING", 
                "value": {
                    "enabled": true
                }
            }
        }
    ]
}

In case all the identifiers are invalid, then response code will still be 200, with an empty response body.