/
† user_action_list ( )

† user_action_list ( )

Owned by Former user (Deleted)
Last updated: Nov 21, 2024 by Pedro Jose Sanchez Luling
2 min read

Definitively removed in API Version 2.8.1

DEPRECATED IN API VERSION 2.7.8 (replaced by action_list_user ())

Function prototype

user_action_list(session, id, action {, path}{, parameter}

API Version

ALL

 

This function returns the possible actions available for the active user In the TASKS and EVENTS page.

This function returns a list of possible choices related with a TASK or EVENT insertion (currently only EVENT actions are available).

Input

parameters:

  • session: is the session id obtained in the session_init call

  • id: reference to the USER for whom the list of actions is requested

  • action: type of actions requested. If null, then the list of available actions will be returned. Possible values:

    • "EVENT": Returns actions for posting a new EVENT

  • path: The goal of this parameter is to organize the actions hierarchically (as in a file tree where path represents the subdirectory). When calling action_list_user(), some of the actions returned may be of type PATH, in which case the value of the path returned can be used to make a subsequent call to patient_action_list() to get the actions nested in that path.

  • parameter: is the date that will be associated to the action. If no date is specified, then the current date will be used

Output

parameters:

  • result: XML with the list of possible actions. Each action in the XML contains:

    • ref: action reference that can be used to invoke action_exec (). If the action is of class PATH, then this it can be used to call again the function passing the value in the path parameter to obtain a new list of actions

    • name: short name in the active session’s language

    • description: description in the active session’s language

    • class: PATH | ACTION

    • type: action type

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

action_list_user ( “LCAAAAAAAAAAAA”, 13232, “EVENT” );

Response

sample:

 

<result> <?xml version="1.0" encoding="utf-8"?> <actions> <description>Select the type of message</description> <action> <ref>ACTION=MESSAGE&issuer=POSTER&event_multi=1&event_type=2</ref> <name>CARE ISSUE</name> <description/> <class>ACTION</class> <type>MESSAGE</type> </action> <action> <ref>ACTION=MESSAGE&issuer=POSTER&event_multi=1&event_type=1</ref> <name>SOCIAL ISSUE</name> <description/> <class>ACTION</class> <type>MESSAGE</type> </action> </actions> </result> <ErrorMsg></ErrorMsg> <ErrorCode></ErrorCode>

 

Notes:

 

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 create request the 'action' indicated

USER.NOT_FOUND

The USER reference provided does not correspond to an existing USER

 

Related content