TABLE OF CONTENTS
- Parameters
- Example
ADDITIONAL INFO
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 |
CompanyId | Integer | Your unique Company ID is found on the Organization Setup page of the secure website. | ✓ |
IntegrationKey | String | Your unique Integration Key is found on the Organization 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 the Postman API Platform.
The below example demonstrates a simple request returning all Mapping screens from a specific company account.
Request URL
https://secure.amplusforms.com:443/api/v2/screen/map/search?CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
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
},
"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
}