/
case_evolution_graph()

case_evolution_graph()

Owned by Pedro Jose Sanchez Luling
Last updated: Jul 02, 2021
Function prototype

case_evolution_graph(session, case, data_code , [filter] , [from_date] , [to_date], [graph_format])

API Version2.6.15 and higher

This function returns a list of possible actions that a PROFESSIONAL can execute for a CASE.Generates an evolution graph for the selected CASE. The data to generate the graph is obtained searching ITEMS with a DATA CODE named data_code in all the TASKs of the CASE (no matter which ADMISSION)

Each value returned has a datetime assigned which is generally the datetime of the TASK where the value was found, but this behavior can be changed as explained in EVOLUTION Values and Dates.

If there exists a GOAL OBJECT defined for the DATA CODE selected, then the graph will also include a line displaying the value of the goal so that it is possible to compare if the value of the DATA CODE at each date is over or below the expected goal.

The graph generated is a PNG picture

Input

parameters:

  • session: a token obtained by calling session_init ()
  • case: a CASE reference
  • data_code: the DATA CODE whose values will be displayed in the graph. It is possible to categorize a single DATA CODE in several series as explained in GRAPH_EVOLUTION() formula
  • filter: a JSON expression with any of the following criteria (see SUBSCRIPTION FILTER (JSON) for details):
    • program
    • subscription
    • subscription_status
    • subscription_team
    • subscription_role
    • admission_status. Introduced in API Version 2.7.20
  • from_date: optional start date. If provided only DATA_CODES in TASKS equal or posterior to this date will be included
  • to_date: optional end date. If provided only DATA_CODES in TASKS prior to this date will be included
  • graph_format: a JSON expression with graph formatting options. See GRAPH FORMAT (JSON). This value may be overridden if a specific graph format has been defined for the selected data_code. See EVOLUTION GRAPH FORMAT CODES CODE for more information. Note that in the latter case, only the 'seriesFormat' part of the GRAPH FORMAT (JSON) is replaced by the predefined format, but the general properties specified in graph_format parameter will be respected

Output

parameters:

  • result: XML containing the picture generated:
    • format: type of picture (currently always "png")
    • bytes: image bytes base64 encoded
  • 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:

case_evolution_graph(“LC53060c6f729de8.42629546”, 342,'ACT_STEPS', null, '2020-10-01', '2020-11-01')

Response

sample:

<?xml version="1.0" encoding="UTF-8"?> <result>
<result>
  <graph>
    <format>png</format>
    <bytes>iVBORw0KGgoAAAA</bytes>
  </graph>
</result>
<ErrorMsg></ErrorMsg>
<ErrorCode></ErrorCode>


This is an example of PNG returned. Note that in this example there exists a GOAL OBJECT defined for the DATACODE "ACT_STEPS". For that reason the graph includes a dotted line indicating the expected goal at each date and draws the values of ACT_STEPS as 'Reached' or 'Failed' based on the comparison with the goal.

Notes:


Return Error codes

ERROR CODE

INVALID_TOKEN

The session token provided is not valid
EMPTY_PARAMSOne or more mandatory parameters are empty
CASE.NOT_FOUNDThe case reference indicated does not correspond to an existing CASE

INVALID_FILTER

The value provided in parameter filter does not correspond to a valid filter
GRAPH.INVALID_FORMATThe formatting options of the graph do not have a valid JSON format

INVALID_DATE

The date indicated in from_date or to_date is not valid

Related content