TABLE OF CONTENTS
- Parameters
- Example
ADDITIONAL INFO
- API Explorer
The GET Screen (Iconboard Search) API returns the Published version of the matching Icon Boards or all versions of a specified Icon Board.
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/iconboard/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 Icon Boards or all versions of a specified Icon Board.
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.
The below example demonstrates a simple request returning all Icon Board screens from a specific company account.
Request URL
https://secure.amplusforms.com:443/api/v2/screen/iconboard/search?CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Response Body
{
"IconBoardScreens": [
{
"Id": "174XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Asset Manager",
"Icon": "PriceTag",
"Version": 2,
"Status": "Published",
"IsLatestVersion": true,
"Settings": {
"RestrictToGroup": "00000000000000000000000000000000",
"HideFromUsers": false
},
"CompanyId": 6XXXX
},
{
"Id": "5a4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Field Sales Start",
"Description": "This is the start screen of the Field Sales app.\r\nIn the design you will see that we have placed icons which open up the respective other screens.\r\nIcon Board screens like this one are one the easiest ways to control the user navigation of your app.",
"Icon": "Star",
"Version": 5,
"Status": "Published",
"IsLatestVersion": true,
"Settings": {
"RestrictToGroup": "00000000000000000000000000000000",
"HideFromUsers": false,
"DisplayOrder": 1
},
"CompanyId": 6XXXX
},
{
"Id": "166XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Inventory App",
"Icon": "Info",
"Version": 1,
"Status": "Published",
"IsLatestVersion": true,
"Settings": {
"RestrictToGroup": "00000000000000000000000000000000",
"HideFromUsers": false
},
"CompanyId": 6XXXX
}
],
"TotalRows": 3
}