POST Screen

POST Screen

TABLE OF CONTENTS



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. 


NameTypeDescriptionRequired
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
ArrayThe settings for this Form.

Connectors
ArrayThe 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 Forms On Fire API. 


{
  "Id": "",
  "Name": "",
  "Description": "",
  "ExternalId": "",
  "Icon": "",
  "Version": 0,
  "ChangeStatusTo": "",
  "Design": [
  ],
  "Settings": {

  },
  "Connectors": [
    {
    }
  ],
  "DesignFormat": "",
  "CompanyId": 0,
  "IntegrationKey": ""
}
JavaScript


    • Related Articles

    • POST Folder

      The POST Folder API creates a new folder in the company's account. 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 ...

    • POST Repository API (Create)

      TABLE OF CONTENTS Parameters Example The POST Repository API registers new content from a company account into the Repository. This API is available via SSL-secured HTTPS connection on the Cloud using the REST POST verb. The format query string ...

    • POST Repository API (Create Installations)

      TABLE OF CONTENTS Parameters Example Using this API endpoint and the POST verb, you can install/update repository item content in a target company account. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. ...

    • POST User

      TABLE OF CONTENTS POST Request POST Response User Response () User () Response Fields API Usage Example POST Request You may use either JSON or XML formats in your request. You indicate this by setting the ContentType HTTP header as ...

    • POST Company

      The Company API allows you to retrieve, create and delete client Companies on the platform. This enables scenarios where Companies created/maintained in other systems (e.g,. SAP, Salesforce) can be replicated to the platform automatically. On our ...