TABLE OF CONTENTS
- Parameters
- Example
ADDITIONAL
The POST Screen Form API allows you to create a form programmatically rather than in the designer.
On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.
/api/v2/screen/form?format=xml/json
You may use either JSON or XML formats in your POST request.
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml".
If no ContentType is specified, XML format is assumed.
All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
Parameters
The POST verb allows you to create a form programmatically rather than in the designer.
The required and optional parameters for a POST call to the Screen API are outlined below.
| |||
Name | Type | Description | Required |
CompanyId | Integer | Your unique Company Id found on the Organisation Setup page of the secure website. | ✓ |
IntegrationKey | String | Your unique Integration Key found on the Organisation Setup page of the secure website. | ✓ |
Name | String | The Form's title used for all default display to app users. | ✓ |
Description | String | The Form's description. |
|
Design | Array[FormScreenControl] | The full design for this Form. |
|
Settings | Array | The settings for this Form. |
|
Connectors | Array | The connectors for this Form. |
|
Example
Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform.
Due to the sheer size and the vast number of possible parameters which can be used in constructing a POST JSON body, we've used a shortened sample of what a JSON Body looks like when making a POST submission to the Amplus Forms API.
{
"Id": "",
"Name": "",
"Description": "",
"ExternalId": "",
"Icon": "",
"Version": 0,
"ChangeStatusTo": "",
"Design": [
],
"Settings": {
},
"Connectors": [
{
}
],
"DesignFormat": "",
"CompanyId": 0,
"IntegrationKey": ""
}