user_get ( session, user )

All

SOAP, REST (Since API Version 2.7.31)

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

IMPORTANT: Remember to call session_init() indicating the appropriate API Version

Input

parameters:

• session: is the token obtained in the session_init call

• user: Reference of the USER. It is possible to indicate a reference of the user in an external system if the format of the reference meets the rules defined in External user references

Output

parameters:

• result/user: an XML with all the information about a USER

  • ref: reference of the USER

  • personal_qr: QR representation of the personal data of the USER. Can be used in other API functions instead of the case reference (see QR OBJECT ). Introduced in API Version 2.7.28

  • pictures: list of pictures associated to the USER

  • identifiers: list of IDENTIFIERS associated to the USER

  • data: Contact information

    • full_name: Concatenation of the name and surnames of the contact. If the name or surname contain Chinese characters, then the full name is the concatenation of the surname and name

    • informal_name: Normally consists on name of the contact. If the name or surname contain Chinese characters, then the full name is the concatenation of the surname and name. Introduced in API Version 2.7.24

    • name

    • surname

    • nickname: nickname of the USER

    • bdate: birth date

    • age: age in years

    • gender: M for male, F for female

    • timezone: Regional timezone code (e.g. “Europe/Madrid”) of the USER. Introduced in API version 2.7.20

    • preferences

      • team_private: (true/false)

      • team_private_locked: (true/false)

      • editable_by_user: (true/false) indicates whether a PROFESSIONAL can edit the CASE profile details or not

      • editable_by_team_manager: (true/false) indicates whether a TEAM MANAGER of a TEAM where the user is member can edit the contact data of the USER.

      • password_expire: (true/false) indicates whether the current password has expired. If true, in the next login it will be requested a password change

      • map_service: Used to define the default map service that should be used when presenting geolocated locations. Introduced in API version 2.7.7

        • code: one of the GEOLOCATION.PROVIDER CODES

        • description: Name of the map service translated to the active session language

      • notifications: preferences about communication channels to receive messages from the system when something happens (e.g. when an Event is sent to this USER)

        • channels: (email, phone, webalert, push) comma separated string with preferred communication channels to receive notifications about TASKS and EVENTS

        • event_priority: (all, flagged). Indicates which EVENTs should be notified based on their priority. The default value is "all", which means that all EVENTs will be notified to the CASE through the selected notification channels. Otherwise, only EVENTs with priority will be notified. Introduced in API version 2.7.15

        • 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

      • custom_preferences: List of customized preferences. A customised preference can be set using the API function user_set () or executing FORMULA USER_PREFERENCE_SET () from within an ITEM of a FORM

        • ref

        • value

        • scope

        • scope_ref

• ErrorMsg: any fault in the call, either in the validation of input parameters, errors in the connection to the database or any other error, this parameter returns the error message produced

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

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to request the information