/
user_get_favorites ( session {, user})

user_get_favorites ( session {, user})

Owned by Pedro Jose Sanchez Luling
Jun 27, 2019

Returns a list of favorite items of the USER. These items are normally set from a client user interface and are used to store some preferences of the USER.

NOTE:

  • Currently this function returns an empty response (pending definition of which items can be included as favorite items)
  • Currently there is no API function to set the favorite items

This operation is restricted by privileges granted to the session's user. It is only allowed if:

  • The USER is a PROFESSIONAL
  • The session's user is a PROFESSIONAL

Input

parameters:

  • session: a token obtained by calling session_init ()
  • user: a USER reference. If no user is specified, the current session user will be assumed

Output

parameters:

  • result/favorites: root node of the response
  • 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: the code of the error (if any)

Request

sample:

user_get_favorites ( “LCAAAAAAAAAAAA”, 32131)

Response

sample:

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

<result>

<favorites>
</favorites>

</result>

<ErrorMsg></ErrorMsg>

<ErrorCode></ErrorCode>

Notes:


Return Error codes

ERROR CODE

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to request the list of favorite items

USER.NOT_FOUND

The USER reference provided does not correspond to an existing USER or it is not a PROFESSIONAL

Related content