/
user_set ()

user_set ()

Owned by Former user (Deleted)
Last updated: Jan 10, 2024 by Pedro Jose Sanchez Luling
3 min read

Function prototype

user_set ( session, user )

API Version

All

Supported interfaces

SOAP, REST (Since API Version 2.7.31)

Description

Updates the properties of the USER.

Input parameters:

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

  • user: User properties formatted as a XML string

    • ref: reference of the USER

    • data: Contact information

      • 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.32

      • preferences

        • team_private: (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

        • 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.

          • ref

          • value

          • scope

          • scope_ref

Output parameters:

  • result: empty

  • 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 example

user_set ( “LCAAAAAAAAAAAA”, " <?xml version="1.0" encoding="UTF-8"?> <user> <ref>12539</ref> <given_name>Alexey</given_name> <family_name /> <identifiers> <identifier> <label>NICKNAME</label> <value>testalexey</value> </identifier> <identifier> <label>NAT_ES</label> <value>testalexey</value> </identifier> <identifier> <label>PASS</label> <value>testalexey</value> </identifier> </identifiers> <data> <bdate>2000-02-01</bdate> <gender>M</gender> <status /> <preferences> <team_private>false</team_private> <password_expire>true</password_expire> <editable_by_user>false</editable_by_user> <editable_by_team_manager>true</editable_by_team_manager> <map_service> <code>BAIDU</code> </map_service> <notifications> <channels>email, phone</channels> <event_priority>all</event_priority> <from_time>09:00:00<to_time> </notifications> </preferences> </data> </user>")

Response

The response format is XML when the function has been invoked via the SOAP API, and JSON when it has been invoked via the REST API

Return Error codes

ERROR CODE

 

ERROR CODE

 

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to modify the properties of the USER

PRIVATE TEAMS

When the property "team_private" is true, a new TEAM will be created that will be internally associated to the new USER. A USER can only have one private PRIVATE TEAM and the characteristics of this TEAM are:

  • The TEAM OWNER of the PRIVATE TEAM will be the ACTIVE TEAM of the SESSION

  • The ACTIVE TEAM will be included as member of the PRIVATE TEAM with roles (Team Manager, Team Editor)

  • The new USER will be included as member of the PRIVATE TEAM with role "Case Manager" (necessary to create ADMISSIONS)

Additionally, a new SUBSCRIPTION will be created automatically. The subscription will be created for a PROGRAM determined by the following rules:

  1. If the property private_program_code is set, then use this PROGRAM CODE to create the subscription

  2. Otherwise, if the setting #TEAM.PRACTICE_DEFAULT_PROGRAM (see SETTINGS OBJECT) is defined for the PARENT TEAM.

  3. If no PROGRAM CODE has been defined, or it is invalid (the PROGRAM CODE does not exist) then an error will be returned

Once the SUBSCRIPTION is created, the USER will be added as member of the SUBSCRIPTION with role Case Manager

The following diagrams shows the same graphically:

Related content