Scribd
Upload
31 views6 pages

Screen API

The document outlines the GET Screen API for retrieving published and all versions of Map, Listing, and Detail Screens via a RESTful interface. It specifies required parameters such as CompanyId and IntegrationKey, and allows responses in XML or JSON formats. Examples of API requests and response structures are provided for each screen type, detailing the expected output and settings for the screens.

Uploaded by

avengerthor52
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
31 views6 pages

Screen API

The document outlines the GET Screen API for retrieving published and all versions of Map, Listing, and Detail Screens via a RESTful interface. It specifies required parameters such as CompanyId and IntegrationKey, and allows responses in XML or JSON formats. Examples of API requests and response structures are provided for each screen type, detailing the expected output and settings for the screens.

Uploaded by

avengerthor52
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 6

7/15/24, 5:58 PM

GET Screen (Map Search)


TABLE OF CONTENTS
Parameters
Example
ADDITIONAL INFO
API Explorer
General Information

The GET Screen (Map Search) API returns the Published version of matching Map Screens or all versions of a single specified Map Screen.

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/map/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 on this API endpoint allows you to return the Published version of matching Map Screens or all versions of a single specified Map Screen.
The required and optional parameters for a GET call to the Screen API are outlined below.

Name Type Description Required


Your unique Company ID is found on the Organization Setup page of the
CompanyId Integer ✓
secure website.
Your unique Integration Key is found on the Organization Setup page of the
IntegrationKey String ✓
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.
Whether all versions of a single Form screen should be retrieved, if set to
RetrieveAllVersions Boolean
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 the Postman API Platform.

The below example demonstrates a simple request returning all Mapping screens from a specific company account.

Request URL
https://secure.formsonfire.com:443/api/v2/screen/map/search?CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Response Body
{
"MappingScreens": [
{
"Id": "fc8XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Map of Inventory",
"Icon": "Marker",
"Version": 2,
"Status": "Published",
"IsLatestVersion": true,
"LinkedDataSourceId": "add8XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Settings": {
"RestrictToGroup": "00000000000000000000000000000000",
"HideFromUsers": true,
"DisplayOrder": 1

1/6
7/15/24, 5:58 PM

},
"CompanyId": 6XXXX
},
{
"Id": "405XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Field Sales - Client Locations",
"Icon": "Clipboard",
"Version": 2,
"Status": "Published",
"IsLatestVersion": true,
"LinkedDataSourceId": "7aeXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Settings": {
"RestrictToGroup": "00000000000000000000000000000000",
"HideFromUsers": true,
"DisplayOrder": 1
},
"CompanyId": 6XXXX
}
],
"TotalRows": 2
}

2/6
7/15/24, 5:58 PM

GET Screen (Listing Screen Search)


TABLE OF CONTENTS
Parameters
Example
ADDITIONAL INFO
API Explorer
General Information

The GET Screen (Listing Screen Search) API returns the Published version of the matching Listing Screen or all versions of a specified Listing Screen.

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/list/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 on this API endpoint allows you to return the Published version of the matching Listing Screen or all versions of a single specified Listing Screen.
The required and optional parameters for a GET call to the Screen API are outlined below.

Name Type Description Required


Your unique Company ID is found on the Organization Setup page of the
CompanyId Integer ✓
secure website.
Your unique Integration Key is found on the Organization Setup page of the
IntegrationKey String ✓
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.
Whether all versions of a single Form screen should be retrieved, if set to
RetrieveAllVersions Boolean
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 the Postman API Platform.

The below example demonstrates a simple request returning all Listing screens from a specific company account.

Request URL
443/api/v2/screen/list/search?CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Response Body
{
"ListingScreens": [
{
"Id": "9c1XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "List of Inventory",
"Icon": "List",
"Version": 1,
"Status": "Published",
"IsLatestVersion": true,
"LinkedDataSourceId": "add8XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Settings": {
"RestrictToGroup": "00000000000000000000000000000000",
"HideFromUsers": true,

3/6
7/15/24, 5:58 PM

"DisplayOrder": 1
},
"CompanyId": 6XXXX
},
{
"Id": "895XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Field Sales - Client List",
"Description": "This screen lists all Clients found in the Clients Data Source. \r\nNote that \"Hide From Users\" below is ticke
"Icon": "Contact",
"Version": 2,
"Status": "Published",
"IsLatestVersion": true,
"LinkedDataSourceId": "7aeXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Settings": {
"RestrictToGroup": "00000000000000000000000000000000",
"HideFromUsers": true
},
"CompanyId": 6XXXX
},
{
"Id": "f0fXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Field Sales - Product List",
"Description": "Displays the rows found in the Product List Data Source, and opens the Product Detail screen when a row is tappe
"Icon": "Info",
"Version": 1,
"Status": "Published",
"IsLatestVersion": true,
"LinkedDataSourceId": "415XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Settings": {
"RestrictToGroup": "00000000000000000000000000000000",
"HideFromUsers": true
},
"CompanyId": 6XXXX
}
],
"TotalRows": 3
}

4/6
7/15/24, 5:58 PM

GET Screen (Details Screen Search)


TABLE OF CONTENTS
Parameters
Example
ADDITIONAL INFO
API Explorer
General Information

The GET Screen (Details Screen Search) API endpoint returns the Published version of matching Detail Screens or all versions of a single specified Detail Screen.

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/detail/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 on this API endpoint allows you to return the Published version of matching Detail Screens or all versions of a single specified Detail Screen.

The required and optional parameters for a GET call to the Screen API are outlined below.

Name Type Description Required


Your unique Company ID is found on the Organization Setup page of the
CompanyId Integer ✓
secure website.
Your unique Integration Key is found on the Organization Setup page of the
IntegrationKey String ✓
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.
Whether all versions of a single Form screen should be retrieved, if set to
RetrieveAllVersions Boolean
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 the Postman API Platform.

The below example demonstrates a simple request returning all Details screens from a specific company account.

Request URL
https://secure.formsonfire.com:443/api/v2/screen/detail/search?CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Response Body:
{
"DetailScreens": [
{
"Id": "d2fXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Details of Inventory",
"Icon": "Book",
"Version": 2,
"Status": "Published",
"IsLatestVersion": true,
"LinkedDataSourceId": "add8XXXXXXXXXXXXXXXXXXXXXXXXX",
"Settings": {
"RestrictToGroup": "00000000000000000000000000000000",
"HideFromUsers": true,

5/6
7/15/24, 5:58 PM

"DisplayOrder": 1
},
"CompanyId": 6XXXX
},
{
"Id": "775XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Field Sales - Product Detail",
"Description": "This screen shows the details of a selected Product row from the Product List Data Source.\r\nWe have set this s
"Icon": "Info",
"Version": 1,
"Status": "Published",
"IsLatestVersion": true,
"LinkedDataSourceId": "415XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Settings": {
"RestrictToGroup": "00000000000000000000000000000000",
"HideFromUsers": true
},
"CompanyId": 6XXXX
},
{
"Id": "f4dXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Field Sales - Company Detail",
"Description": "This screen displays the details of a selected Company.\r\nNote that we have set the screen to be hidden from us
"Icon": "Building",
"Version": 1,
"Status": "Published",
"IsLatestVersion": true,
"LinkedDataSourceId": "2a0XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Settings": {
"RestrictToGroup": "00000000000000000000000000000000",
"HideFromUsers": true
},
"CompanyId": 6XXXX
},
{
"Id": "4e2XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Field Sales - Client Detail",
"Description": "This is an example of a Detail screen that shows the details of a Client that has been selected through the Clie
"Icon": "Contact",
"Version": 2,
"Status": "Published",
"IsLatestVersion": true,
"LinkedDataSourceId": "7aeXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Settings": {
"RestrictToGroup": "00000000000000000000000000000000",
"HideFromUsers": true
},
"CompanyId": 6XXXX
}
],
"TotalRows": 4
}

6/6

You might also like