/
program_action_list (session, action, id)

program_action_list (session, action, id)

program_action_list (session, action, path, id)

This function returns a list of possible choices related with a program

Input

parameters:

session: is the session id obtained in the session_init call

action: is an action

EVENT: Returns a choice of possible events:

#EVENT:CARE

#EVENT:SOCIAL

#EVENT:ADMIN

#EVENT:TECH

#EVENT:ENROLL_REQ

#EVENT:OPINION_REQ

id: program id

Output

parameters:

result: list of possible actions

ref: action reference. If the action is of type ACTION the action reference is an action_token, otherwise is an action_id

name: short name in the active session’s language

description: description in the active session’s language

class: EVENT | PROGRAM | TASK_PRO |TASK_SYS | PATH | ACTION

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:

action_list ( “LCAAAAAAAAAAAA”,"EVENT", "", "");

Response

sample:

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

<result>


<actions>
<action>
<ref>ACTION=EVENT&TYPE=EVENT:CARE</ref>
<name>short_name</name>
<description>desc</description>
<class> EVENT </class>
</action>
<action>
<ref>action_token</ref>
<name>short_name</name>
<description>desc</description>
<class>ACTION</class>
</action>
<action>...</action>
...
</actions>


</result>

<ErrorMsg></ErrorMsg>

Notes:




Related content