TABLE OF CONTENTS
ADDITIONAL INFO
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/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. | ✓ |
| 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 via your web browser to test it using a REST plugin like the Postman plugin for Google Chrome.
Request URL
https://secure.formsonfire.com:443/api/v2/formentry/file?EntryId=4edcxxxxxxxxxxxxxxxxxxxxxxx&Filename=221xxxxxxxxxxxxxxxxxxx.jpg&CompanyId=6xxxx&IntegrationKey=995xxxxxxxxxxxxxxxxxxxxxxxxxxxx
Response Body
The requested media file is returned.