user_get_preferences (session, [user])

2.7.8 and higher

2.7.25

Notification channels preferences are not divided in "events" and "tasks". From version 2.7.25 there is a single "channels" property to indicate the preferred communication channels for receiving notifications.

See Changes in version 2.7.25 for more details

0.0.0

Initial version

Detailed explanation of the function

Input parameters:

• session: is the session token obtained in the session_init() call

• user: Reference of the USER. By default the function will use the session’s USER unless a different one is specified.

Output parameters:

• result/preferences: XML with the preferences of the USER

  • editable_by_user: (true/false) Indicates if the USER can edit his own profile

  • editable_by_team_manager: (true/false) Indicates if a TEAM MANAGER (of any of the TEAMS of the USER) can edit the profile of the USER.

  • team_private: (true/false) Indicates if the USER has a private TEAM

  • form_merge: (true/false) If true, the TASKS with more than one FORM will be treated as if they had only one FORM with all the ITEMS merged

  • map_service: Information about the preferred map service for displaying geographic information

    • code: Code of the map service provider. See GEOLOCATION.PROVIDER CODES

    • description: Description of the map service provider

  • notifications: Preferences of the USER about the channels of communication used to send notifications generated by the system.

    • channels: comma separated string indicating the channels enabled for sending notifications about TASKs and EVENTs

    • event_priority: Used to filter by priority the EVENTs that should send a notification. Possible values:

      • “all”: Send notifications about all EVENT

      • “flagged“: Send only notifications of flagged EVENTs (with a priority different than 0)

    • from_time: Minimum time to receive notifications about pending TASKS when the TASK is not scheduled for a specific time (can be done at any time of the day). The expected format is 'hh:mm:ss'. Introduced in API version 2.7.25

  • preference: Name of the preference. It is possible to add new preferences using case_set_preference () or USER_PREFERENCE_SET (). Introduced in API Version 2.7.20

    • ref: name assigned to the preference

    • description: Description of the preference

    • value: value assigned to the preference

    • scope: defines in which scope the preference is used. Possible values are:

      • “USER”: Preference assigned to the USER

      • “PROGRAM”: Preference that is applicable only in the context of a PROGRAM OBJECT.

      • “APPLICATION”: Preference stored by an client application. For example it may be used to store preferences of the user about how to sort tables, colors of the interface, or any other setting that may affect the behavior of the client application

    • scope_ref: When the scope is different than “USER”, it is necessary to indicate the reference of the scope. For example, when defining a preference of a PROGRAM, then it is necessary to indicate the reference of the PROGRAM.

    • scope_description: Description of the scope object referenced by scope_ref. For example, if scope = “PROGRAM”, then scope_description will be the name of the PROGRAM

• ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language

• ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request sample:

api_function ( “LCAAAAAAAAAAAA” );

Response sample:

Notes:

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to request the preferences of the USER