POST User/getmobilesettings

Get the mobile settings for the user. Returns settings as a Dictionary of string [key] and string [value].

Request Information

URI Parameters

None.

Body Parameters

AuthenticatedRequest
NameDescriptionTypeAdditional information
token

API access token

globally unique identifier

Required

Request Formats

application/json, text/json

Sample:
{
  "token": "2bd8f18f-b10d-408d-9369-cd3bd132ced7"
}

application/xml, text/xml

Sample:
<AuthenticatedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">
  <token>2bd8f18f-b10d-408d-9369-cd3bd132ced7</token>
</AuthenticatedRequest>

Response Information

Resource Description

GetMobileSettingsResponse
NameDescriptionTypeAdditional information
code

API result code

integer

None.

error

API error message

string

None.

MobileSettings

Dictionary of mobile settings

Dictionary of string [key] and string [value]

None.

APIVersion

API Version

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "MobileSettings": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "APIVersion": 1,
  "code": 200,
  "error": "sample string 1"
}

application/xml, text/xml

Sample:
<GetMobileSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.User">
  <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">1</APIVersion>
  <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
  <MobileSettings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </MobileSettings>
</GetMobileSettingsResponse>