TABLE OF CONTENTS
- Parameters
- Example
ADDITIONAL INFO
- API Explorer
- General Information
The GET Formentry (Search) API finds all form entries that match the given parameters.
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/datasource?format=xml/json
Parameters
The GET verb lets you find all form entries matching the given parameters.
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. | ✓ |
FormExternalId | String | External ID of the Form to fetch entries for. | |
FormVersion | Integer | Version of the Form that you wish to fetch entries for. If not specified or zero (0), will return entries for the latest Published version. Use version of -1 to return entries across all versions of the Form. | |
FormId | String | Identifier of the specific Form Screen to fetch entries for. | |
FromDate | Date | Returns Form entries on or after the given UTC date/time. The default is to filter using the time received by our servers. If you specify the OrderBy parameter as CompletedTime, entries are instead filtered by the time completed on the device. Required format is ISO8601 - i.e. YYYY-MM-DDTHH:MI:SSZ | |
ToDate | Date | Returns Form entries on or before the given UTC date/time. The default is to filter using the time received by our servers. If you specify the OrderBy parameter as CompletedTime, entries are instead filtered by the time completed on the device. Required format is ISO8601 - i.e. YYYY-MM-DDTHH:MI:SSZ | |
AnswerFormat | String | Whether or not to return rich answers or raw answers | |
MediaAsUrl | Boolean | Returns Media answers as full file download URLs instead of just the file name. | |
Fields | String | Optionally restrict returned answer values to the given comma-separated list of field data names. ONLY SUPPORTED WITH 'FLAT' ANSWERFORMAT. | |
OrderBy | String | Order results by time received/uploaded to our platform or the time entry was completed on the user's device. CompletedTime can be inaccurate if the device clock is wrong. The default is ReceivedTime. | |
DateOrder | String | Returns result in either Ascending or Descending order. The default is Ascending (oldest first). | |
PageNo | Integer | The page number from which to start reading results (0 based). | |
PageSize | Integer | The page size (number of rows) to return. The 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 it using a REST plugin like the Postman plugin for Google Chrome.
Request URL
https://secure.amplusforms.com:443/api/v2/formentry/search?CompanyId=6****&IntegrationKey=995*******************************&FormExternalId=EXT_Damage_Report&FormVersion=-1
Response Body
{
"Entries": [
{
"Id": "4ed********************************",
"RowId": 1,
"FormId": "449********************************",
"FormVersion": 11,
"DeviceId": "6a7********************************",
"UserFirstName": "Support",
"UserLastName": "User",
"UserEmail": "cha*******@amplusforms.com",
"UserExternalId": "charles_test_user_extid",
"Latitude": -23.0892846,
"Longitude": 30.545262,
"StartTime": "2022-11-03T17:57:32.9700000Z",
"CompleteTime": "2022-11-03T18:01:54.1170000Z",
"ReceivedTime": "2022-11-03T18:01:55.0730000Z",
"AnswerFormat": "Rich",
"Answers": [
{
"Name": "page1",
"Type": "Group",
"Value": "",
"Answers": [
{
"Name": "Report_reference",
"Type": "Hidden",
"Value": "00001"
},
{
"Name": "client",
"Type": "SelectOne",
"Value": "Julie Interiors"
}
]
}
]
}
]
}
***The results return too many parameters to show them all. You can test the output and see all parameters returned in the API Explorer***.