/
task_activity_list ()

task_activity_list ()

Owned by Alexey Kapitula (Unlicensed)
Last updated: Apr 08, 2024 by Pedro Jose Sanchez Luling
2 min read

Function prototype

task_activity_list ( session, task_id )

API Version

All

Supported interfaces

SOAP, REST (Since API Version 2.7.32

Description

Returns the list of ACTIVITIES (FORMS or REPORTS) contained in a TASK

Required permissions: The operation is only allowed if the active user:

  • When the active USER is the CASE:

    • The TASK belongs to an ADMISSION of that CASE

    • AND the TASK is not canceled

    • AND

      • The TASK is not a Medical Record

      • OR The TASK is a Medical Record and it has been configured as “Visible by the patient”

  • When the active USER is an ASSOCIATE of the CASE:

    • The TASK belongs to an ADMISSION of that CASE

    • AND The ASSOCIATE has permission to browse the TASKS of the CASE

    • AND the TASK is not canceled

    • AND

      • The TASK is not a Medical Record

      • OR The TASK is a Medical Record and it has been configured as “Visible by the patient”

  • When the active USER is a PROFESSIONAL

    • PROFESSIONALS are always allowed to request the data about any TASK

Otherwise an INSUFFICIENT_PRIVILEGES error will be returned.

Input parameters:

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

  • task_id: Reference of the TASK

Output parameters:

  • result: List of the ACTIVITIES contained in the TASK

    • ref: 123135,

    • type: (form/report): indicates the type of ACTIVITY

    • form_code: only in ACTIVITIES of type “form”. Indicates the FORM CODE assigned to the REPORT

    • report_code: only in ACTIVITIES of type “report”. Indicates the REPORT CODE assigned to the REPORT

    • progress: not used

    • editable: true/false

    • name: Name of the ACTIVITY

    • status: (OPEN/CLOSED) only in ACTIVITIES of type “report”. Indicates the status of the FORM

  • 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

function_name ( “LCAAAAAAAAAAAA”, "xxxx")

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 request the list of ACTIVITIES of the TASK

TASK.NOT_FOUND

The TASK requested was not found





Related content