Get Form

This API allows you to pull the form information. More than one form can be pulled.

The endpoints, properties and code examples are given as follows:

GET/forms/:formID

The form ID needs to be passed to get the particular form. For more than one form, add formID separated by comma. If no ID is specified, the API will return all available forms.

Response Code Description

200

Code 200 implies that the form(s) has been retrieved successfully. Example is given as follows:

Response Body:

CODE

 [
    {
        "id": "1",
        "formTitle": "New Form",
        "formDescription": "This is helping text.",
        "attributes": [
            {
                "key": "first_name",
                "label": "First Name",
                "helpText": "This is helping text",
                "attributeType": "INPUT",
                "valueType": "String100",
                "isRequired": true,
                "categoryOptions": {}
            },
            {
                "key": "state_name",
                "label": "State Name",
                "helpText": "This is helping text",
                "attributeType": "OPTIONS",
                "valueType": "StringList",
                "isRequired": true,
                "categoryOptions": {
                    "isMultipleChoice": true,
                    "categories": [
                        {
                            "categoryName": "Category1",
                            "values": [
                                "Badin",
                                "Chaman",
                                "Balakot"
                            ]
                        }
                    ]
                }
            }
        ]
    },
    {
        "id": "2",
        "formTitle": "New Form",
        "formDescription": "This is helping text.",
        "attributes": []
    }
]

Quick Links