The GET Formentry (File) API allows you to download a media file captured on a given Form Entry.
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/formentry/file?format=xml/json
Endpoints & API Explorer
| Node | API Endpoint | API Explorer |
|---|---|---|
| US | api/v2/formentry/file | Model Description/Schema & Parameters |
Parameters
The GET verb allows you to find all form entries that match 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 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. | ✓ |
| EntryId | String | The unique identifier of the entry to which the requested file belongs. | ✓ |
| Filename | String | The name of the file to retrieve, as specified in the entry answer. | ✓ |
Example
Given that the API is REST-based, you can access the API directly using a REST client such as Postman, a popular standalone application for testing APIs.
Use the GET Formentry endpoint first to retrieve the entryID and filename of the media files you’re trying to access. Make sure to have MediaAsUrl=false to get the filename you need to interface with the API endpooint.
Request URL
https://eforms.mobileform.net:443/api/v2/formentry/file?EntryId=4edcxxxxxxxxxxxxxxxxxxxxxxx&Filename=221xxxxxxxxxxxxxxxxxxx.jpg&CompanyId=6xxxx&IntegrationKey=995xxxxxxxxxxxxxxxxxxxxxxxxxxxxResponse Body
The requested media file is returned.