The Screen Form API returns the Form Screen matching the given parameters.
On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET 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 GET 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”
Endpoints & API Explorer
| Node | API Endpoint | API Explorer |
|---|---|---|
| US | /api/v2/screen/form | Model Description/Schema & Parameters |
Parameters
The GET verb allows you to return the Form Screen matching the form Id (GUID) provided. The required and optional parameters for a GET 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. | ✓ |
| Id | String | The Form’s unique identifier (GUID). | |
| ExternalId | String | The Form’s external identifier. | |
| Version | Integer | The Form’s current version. | |
| Status | String | The Form’s current Status | |
| DesignFormat | String | Whether to return only field definitions or the entire design. |
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.
Request URL
https://eforms.mobileform.net:443/api/v2/screen/form?CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&Id=3472XXXXXXXXXXXXXXXXXXXXXXXXXXResponse Body
{
"FormScreen": {
"Id": "347XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Safety Checklist (DS-Driven)",
"Icon": "Airplane",
"Version": 2,
"Status": "Published",
"Fields": [
{
"Name": "page1",
"Type": "Group"
},
{
"Name": "submission_id",
"Title": "Submission ID",
"Type": "Text",
"Parent": "page1"
},
{
"Name": "logged_in_user",
"Title": "You are logged in as:",
"Type": "Text",
"Parent": "page1"
},***The results return too many parameters to show them all. You can test the output and see all parameters returned in the API Explorer***