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.

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

{
  "FormScreens": [
    {
      "Id": "347XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "Name": "Safety Checklist (DS-Driven)",
      "Icon": "Airplane",
      "Version": 2,
      "Status": "Published",
      "Fields": [
        {
          "Name": "page1",
          "Type": "Group"
        },