/
user_list ()

user_list ()

Owned by Former user (Deleted)
Last updated: Jun 27, 2023 by Pedro Jose Sanchez Luling
3 min read

Function prototype

user_list (session, search_str , [max_res = 1000], [offset = 1])

API Version

All

Supported interfaces

SOAP

Description

Returns a list of professional USERs that match the search criteria

This function is similar to user_search (), but only searches in the local database (never in an external HIS)

If a simple string is provided in the search_str parameter, it will we used to find USERS who:

  • The name/surname matches the search string

  • Have a communication channel (eMail, Phone) that matches the search string

  • Have any IDENTIFIER that matches the search string

Input parameters:

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

  • search_str: is the text with we made the matching search in the list of USERS. It is possible to provide a simple string or a structured JSON expression to customize search. See below the Search expression format

  • max_res: It sets the maximum number of USERS to be returned by the function

  • offset: the base-one position of the first USER to be returned

Output parameters:

  • result: List of users

    • user_list:

      • user: 

        • ref: is the source of the admission, must be Linkcare or a HIS connected to Linkcare

        • gender: M for male F for female

        • nickname: is the nickname of the USER

        • full_name: is the full-name of the USER if it’s informed

  • 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_list ( “LCAAAAAAAAAAAA”, "john")

Response

<?xml version="1.0" encoding="utf-8" standalone="yes"?> <result> <user_list>   <user>     <ref>5283</ref> <gender>M</gender>     <nickname>Fisioterapeuta F.</nickname>     <full_name>Fisioterapeuta Fisio </name_complete>   </user>   <user>     <ref>5319</ref> <gender>F</gender>     <nickname>Elena G.</nickname>     <full_name>Elena Gimeno </name_complete>   </user> </user_list> </result> <ErrorMsg></ErrorMsg> <ErrorCode></ErrorCode>

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 …

JSON search expression format

It is possible to provide a JSON formatted string in the parameter search_str to customize the search of USERS. The structure of the JSON string can contain:

  • identifier: Search by IDENTIFIER: allows to search CASES that have an specific IDENTIFIER in their contact data with the requested value. To use this search type it is necessary to provide 2 values:

    • code: name of the IDENTIFIER (e.g. "NAT_ZH"). If it is empty, the search will be done for any IDENTIFIER of the CASE

    • value: Value searched (the value that the IDENTIFIER of the CASE should have)

    • program: This filter only takes effect when searching an IDENTIFIER OBJECT that is a SUBSCRIPTION IDENTIFIER. If provided, only the IDENTIFIERS assigned to CASES in SUBSCRIPTIONs of that PROGRAM will be considered

    • team:This filter only takes effect when searching an IDENTIFIER OBJECT that is a SUBSCRIPTION IDENTIFIER or a TEAM IDENTIFIER.

      • If the program filter is also provided, only the IDENTIFIERS assigned to CASES in SUBSCRIPTIONs of that TEAM will be considered

      • Otherwise, only the TEAM IDENTIFIERS related with the selected TEAM will be considered

  • username: Search by username

If more than one search criteria is provided, the funcion will return the USERS that match simultaneously all of them (logical AND)

The following example requests to search any patient with

  • An IDENTIFIER called "NAT_ES" with value "72266626D"

  • AND username = "kx822"

{ "identifier" : { "code": "NAT_ES", "value": "72266626D" }, "username" : "kx822" } }

 

 

Is a function to  retrieve a list of users if the current session’s active center. If a certain role or program is defined the list will only include users with the specified role and program

Input

parameters:

session: a token obtained by calling session_init ()

program: a program

role: a role_id

event_id: is the reference of a event, used to know the old user/professional assigned to show in the list too.

Output

parameters:

user_list: a list of users

user: a user object

id: a user reference

nickname: Is the nickname of the person/professional

name_complete: is the name complete of the person/professional

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

Request

sample:

user_list ( “LCAAAAAAAAAAAA”, “program_id“, “role_id”)

Response

sample:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<result>



<user_list>   <user>     <id>5283</id>     <nickname>Fisioterapeuta F.</nickname>     <name_complete>Fisioterapeuta Fisio </name_complete>   </user>   <user>     <id>5319</id>     <nickname>Elena G.</nickname>     <name_complete>Elena Gimeno </name_complete>   </user>   <user>     <id>5577</id>     <nickname>Anael B. G.</nickname>     <name_complete>Anael Barberán Garcia</name_complete>   </user>   <user>     <id>5581</id>     <nickname>Beatriz V.</nickname>     <name_complete>Beatriz Valero </name_complete>   </user>   <user>     <id>5578</id>     <nickname>Jordi V.</nickname>     <name_complete>Jordi Vilaró </name_complete>   </user>   <user>     <id>5579</id>     <nickname>Ane A.</nickname>     <name_complete>Ane Arbillaga  </name_complete>   </user>   <user>     <id>5582</id>     <nickname>Diego a R.</nickname>     <name_complete>Diego A Rodriguez </name_complete>   </user> </user_list>



</result>

<ErrorMsg></ErrorMsg>

Notes:





Related content