Viewapplicationsettings

Retrieve the user-application settings for all applications that have settings for the given user.

Tokens

This action requires the following tokens:

  • userapplicationsettings-read

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
user Hash   The user for which to retrieve all stored settings.
application Hash   Show only user-application settings for this application.

Output

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
user

The user for which these are the settings

The value of this field is an object containing the following fields:

Name Type Description
id Hash User ID
username String User name
application

The application for which these are the settings

The value of this field is an object containing the following fields:

Name Type Description
id Hash Application ID
name String Application name
description String Application description
iplock IP Mask IP-lock data for this application
datecreated DateTime When the application was created
datemodified DateTime When the application was last modified
active Boolean Whether this application is active
account Hash Account for this application
customer Hash Customer for this application
timezone TimeZone Timezone for this application
datecreated DateTime When these settings were created
datemodified DateTime When these settings were last modified
settings JSON The actual settings themselves

Errors

This action can return one of the default status codes, or one of the following status codes on error:

STATUS_USER_NOT_FOUND (310)
The given user could not be found.
STATUS_APPLICATION_NOT_FOUND (260)
The given application could not be found.