/
admission_get_task_calendar ()

admission_get_task_calendar ()

Owned by Pedro Jose Sanchez Luling
Last updated: May 17, 2023
Function prototype

admission_get_task_calendar ( session , admission , [filter = null])

API Version2.6.4 and higher

Returns a calendar of TASKS and/or EVENTS of an specific ADMISSION.

The calendar consist of a summary of the TASKs existing in each day of a date range. The date range is specified into the "filter" parameter 

This operation is restricted by privileges granted to the session's user. Privileges are granted when:

  • The session´s USER is a PROFESSIONAL and has any ROLE assigned to in the SUBSCRIPTION of the ADMISSION
  • The session's user is the CASE of the ADMISSION
  • The session's user is an ASSOCIATE of the CASE of the ADMISSION with permission to see the CASE's TASKS and/or EVENTS

Input

parameters:

  • session: a token obtained by calling session_init ()
  • admission: reference to an ADMISSION
  • filter: a JSON expression with any of the following criteria (see TASK FILTER (JSON) for details).

Output

parameters:

  • result/dates: a list of dates with TASKS with a summary of the number of TASKs per day. For each EVENT or TASK, the information provided is:
    • closed: Number of elements in 'closed' status
    • open: Number of elements in 'open' status
    • not_read: (only EVENTS) Number of EVENTS not read by the active USER
    • flagged: (only EVENTS) Number of EVENTS that have a priority set. Introduced in API Version 2.7.15
  • 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:

admission_get_task_calendar ( “LCAAAAAAAAAAAA", filter = '{from_date : "2017-04-01", "role" : "39, 41"}')

Response

sample:

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

<result>

<dates>
  <total>
    <events>
      <closed>5</closed>
      <open>4</open>
      <not_read>0</open>
      <flagged>0</flagged>
    </events>
    <tasks>
      <closed>5</closed>
      <open>4</open>
    </tasks>
  </total>
  <date>
    <value>2017-04-01</date>
    <events>
      <closed>5</closed>
      <open>4</open>
      <not_read>0</open>
      <flagged>0</flagged>
    </events>
    <tasks>
      <closed>5</closed>
      <open>4</open>
    </tasks>
  </date>
  <date>..</date>
</dates>

</result>

<ErrorMsg></ErrorMsg>

Notes:

  • A TASK is considered to be 'external' if the USER has not enough privileges. When a TASK is 'external' the user has no privileges to complete it (but can view it)

Related content