/
user_get_task_calendar ()

user_get_task_calendar ()

Owned by Pedro Jose Sanchez Luling
Last updated: Oct 07, 2020
Function prototype

user_get_task_calendar ( session , user , [filter = null])

API Version2.6.4 and higher

Returns a calendar of TASKS and/or EVENTS of any ADMISSIONS assigned to the USER

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

This operation is restricted only to PROFESSIONALS:

Criteria for obtaining the list of TASKS:

  • The TASK is assigned to the USER (whatever TEAM and ROLE)
  • Or the TASK is not assigned to a USER but is assigned to a ROLE and a TEAM, and:
    • The USER is "PROGRAM ADMINISTRATOR", what requires:
      • the USER is direct member of the SUBSCRIPTION with ROLE "PROGRAM ADMINISTRATOR"
      • OR the USER has the ROLE "PROGRAM ADMINISTRATOR" in that TEAM and the TEAM has also the role PROGRAM ADMINISTRATOR in the SUBSCRIPTION
    • AND the USER specified belongs to that TEAM with that ROLE
  • Or the TASK is not assigned to a USER nor a TEAM, but it is assigned to a ROLE, and:
    • The USER is member of the SUBSCRIPTION with role "PROGRAM ADMINISTRATOR",
    • AND 
      • the USER is direct member of the SUBSCRIPTION with the ROLE assigned to the TASK
      • OR the USER is member of any TEAM member of the SUBSCRIPTION with the ROLE assigned to the TASK
  • Or the TASK is not assigned to a USER, nor TEAM, nor ROLE and the USER specified is member of the SUBSCRIPTION with ROLE "PROGRAM ADMINISTRATOR"

Input

parameters:

  • session: a token obtained by calling session_init ()
  • user: a USER reference. If NULL, the session's USER will be considered
  • 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:

user_get_task_calendar ( “LCAAAAAAAAAAAA”, NULL, 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 'locked' if it belongs to a SUBSCRIPTION of which the session's user is not member
  • 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