/
form_close ( )

form_close ( )

Owned by Former user (Deleted)
Last updated: Dec 11, 2024 by Pedro Jose Sanchez Luling
3 min read

Function prototype

form_close (session, form, [next=false])

API Version

All

Supported interfaces

SOAP

Description

When a form is open (unlocked), call this function to close (lock) a task form.

If the task is a system action, then the function generates an action to the admission related to the task.

The function changes the form status to CLOSED and update the role to:

  • If it has role and not user assigned, It’s assign the role of the session given in the input parameter

  • If have role assigned and is the same as the session, It changes the user for the user of the session and if the user of the session is the “Case Manager” and the task have assigned user and role, the role not changes.

The function detects if the task have more forms and if all forms are closed the task is turned to “done”

Then if the activity is a System action, it will have the “Case Manager” role assigned. This function make modifications in the admission and his all other activities:

  • “X1 DISCHARGE”: modifiy the status of the Admission to “4 - Inactive”, modify the discharged dates of the admission

  • “X2 REJECT”: modify the status of the Admission to “2 - Rejected” and modify the rejected date of the admission.

  • “X3 PAUSE”:  modify the status of the Admission to “6 - Suspended” and modify the suspended date of the admission. Then, change the status of all pending tasks ( 11 – Not assigned ) to (16 – Paused).

  • “X4 RESUME”: modify the status of the Admission to “ 1 – Active” and modify all the (16 – Paused) tasks before the Suspended date to the status ( 11 – Not assigned ) and replace all dates of the task to a new dates. This date is the sum of Today with the days between the old date of task and the suspended date of the admission.

 All this modifications and changes of state of the admissions use the calls: admission_reject(), admission_suspend(), admission_resume(), admission_discharge()

Input parameters:

  • session: is the session id obtained in the session_init call

  • form: is the ID of the form obtained by the URL or by the call task_activity_list ()

  • next: (default = false). If true, the function also returns information about the next question available to be answered in other FORM or TASK of the same ADMISSION than the current FORM

Output parameters:

  • result: 

    • next: An XML containing information about the next question available to be answered. Contains the following values:

      • next_question: The next question that needs to be answered. There is a special case when a previous question in the FORM is empty and is also mandatory. In this case that question will be returned as 'next question'

      • next_form: Reference to the FORM where the "next" question is located

      • next_task: Reference to the TASK where the "next" question is located

      • next_strict_question: The next visible question (no matter if it needs to be answered or not, nor whether is editable or not)

      • next_strict_form: Reference to the FORM where the "next_strict" question is located

      • next_strict_task: Reference to the TASK where the "next_strict" question is located

  • 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

form_close( “LCAAAAAAAAAA”, “1234”, "true");

Response

<?xml version="1.0" encoding="UTF-8"?> <result> <?xml version="1.0" encoding="utf-8"?> <next> <next_question/> <next_form/> <next_task/> <next_strict_question/> <next_strict_form/> <next_strict_task/> </next> </result> <ErrorMsg/> <ErrorCode/>

Return Error codes

ERROR CODE

 

ERROR CODE

 

INVALID_TOKEN

The session token provided is not valid

FORM.NOT_FOUND

The requested FORM was not found

 

 

Related content