Description 

The function formCreate adds one or more forms to Experiential Learning Cloud.

 

Data 

Name	Type	Description	Required	CTM Table/Field
forms	Array	List of forms to create	X	Form

CSV 

formCreate supports the CSV file format

• Field names at the form level should be prefixed with "form.".  
• Field names at the data node level should be prefixed with "node.".  
• There must be a column with the header "form.index", which shows which form the current line should apply to.  
  • The data in this column has no other requirement than to be consistent within the form.

Example:

form.index,form.num,form.formDestination,form.staffNum,form.clientNum,form.locationNum,form.programNum,node.name,node.number,node.date,node.text,node.options
1,CTM101,location,101,,100,10,type,,,,1|5
2,CTM102,location,102,,101,11,information,,,ipsum,
2,CTM102,location,,,,,type2,,,,7

 

Actions 

Forms

For each form in the forms array, the command will create a new form_data record.  If the form type requires a link record and the required information is selected (clientNum, staffNum, locationNum) this will also create a form_link record.

Nodes 

For each node in the nodes array, the command will create a new form_data_node record.  

Field	Value
form_data_id	The form data of the associated node
form_def_node_id	The archetype for the data node
number	The numeric value of the node (If set)
date	The date value of the node (If set)
text	The text value of the node (If set)

Options 

For each option in the options array, the command will create a new form_data_option record.  

Field	Value
form_data_node_id	The node associated to the option
form_def_option_id	The option that was selected

 

Examples 

JSON 

{ 
"command"    :"formCreate", 
"source"    :"test source", 
"email"        :"test@test.com",  
"forms":
    [
        {
        "num"            :"CTM101",
        "staffNum"        :"10297",
        "locationNum"    :"VL001",
        "programNum"    :"1",
        "clientNum"        :"",
        "nodes":
            [
                {
                "name"        :"type",
                "options":
                    [
                    1,
                    7
                    ]
                },
                
                {
                "name"        :"clinicians",
                "options":
                    [
                    1
                    ]
                },
                
                {
                "name"        :"populations",
                "options":
                    [
                    1,
                    2
                    ]
                },
                
                {                                            
                "name"        :"deadline",
                "date"        :"2017-01-01"
                }                                                
            ]
        }                    
    ] 
}