TABLE OF CONTENTS
- Parameters
- Example
The Screen API returns the Published version of matching Forms or all versions of a specified Form.
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/search?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"
Parameters
The GET verb allows you to return the Published version of matching Forms or all versions of a specified Form.
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. | ✓ |
ExternalIds | String | List of Form external Ids to search for - must be comma separated. |
|
FromDate | Date | Search for Forms last updated since the given date. |
|
ToDate | Date | Search for Forms last updated before the given date. |
|
RetrieveAllVersions | Boolean | Whether all versions of a single Form screen should be retrieved, if set to true, only one, External ID must be specified. |
|
PageNo | Integer | The page number from which to start reading results (0 based). |
|
PageSize | Integer | The page size (number of rows) to return. Maximum allowable value is 250. |
|
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
443/api/v2/screen/form/search?CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Response Body
{
"FormScreens": [
{
"Id": "347XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Safety Checklist (DS-Driven)",
"Icon": "Airplane",
"Version": 2,
"Status": "Published",
"Fields": [
{
"Name": "page1",
"Type": "Group"
},
***The results return too many parameters to show them all. You can test the output and see all parameters returned in the API Explorer***