User Settings

usersettings

ParameterType
ModelStructureString
styleString
ResponseXML / JSON

Description

Calling the users API with a modelstructure of usersettings retrieves the user’s default application settings e.g. default timezone, default company, dateformat and country.

Return Values

Response – User’s application settings.

The structure of the response is:

<users morepages="False" totalpages="1" totalrows="1">
<user users_uuid="56205AC1D69E427A8F3F7B531126AC82">
<variable_dateformat__users_userid>dd/mm/y</variable_dateformat__users_userid>
<variable_defaultcompany__users_userid>1</variable_defaultcompany__users_userid>
<variable_defaultcompanyname__users_userid>
The Professional Services Company
</variable_defaultcompanyname__users_userid>
<users_uuid>56205AC1D69E427A8F3F7B531126AC82</users_uuid>
<users_userid>11111</users_userid>
<users_username>JB</users_username>
<users_fullname>Jo Bloggs</users_fullname>
<users_timezonecode>UTCA</users_timezonecode>
<users_country>UK</users_country>
</user>
</users>
{
    "responsecode": 1,
    "responsestatus": "OK",
    "errorcode": 0,
    "errormessage": "",
    "totalrows": 1,
    "totalpages": 1,
    "responsemessage": "",
    "pagerows": 0,
    "pagenumber": 1,
    "success": true,
    "data": [
        {
            "users_uuid": "56205AC1D69E427A8F3F7B531126AC82",
            "variable_dateformat__users_userid": "dd/mm/y",
            "variable_defaultcompany__users_userid": "1",
            "variable_defaultcompanyname__users_userid": "The Professional Services Company",
            "users_userid": 111111,
            "users_username": "JB",
            "users_fullname": "Jo Bloggs",
            "users_timezonecode": "UTCA",
            "users_country": "UK"
        }
    ]
}