TABLE OF CONTENTS
- Parameters
- Example
ADDITIONAL INFO
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 |
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 Details screens from a specific company account.
Request URL
https://secure.amplusforms.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,
"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 screen to \"Hide From Users\" since the only way to access this screen is from the Product List screen.",
"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 users since we do not want it to be displayed by default - it is only accessed the user tapping on the company name found in the Client Detail screen.",
"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 Client List screen.\r\n\r\nNote that \"Hide From Users\" below is ticked on since it requires a selected Client to be passed in from another screen in order to function.\r\n\r\nIn the design you will see that several detail fields have been linked to user interactions that will open phone dialer, web browser and even another screen in the case of the company field.",
"Icon": "Contact",
"Version": 2,
"Status": "Published",
"IsLatestVersion": true,
"LinkedDataSourceId": "7aeXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Settings": {
"RestrictToGroup": "00000000000000000000000000000000",
"HideFromUsers": true
},
"CompanyId": 6XXXX
}
],
"TotalRows": 4
}