GET Formentry (File)

GET Formentry (File)


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.


NameTypeDescriptionRequired
CompanyIdIntegerYour unique Company ID is found on the Organization Setup page of the secure website.
IntegrationKeyStringYour unique Integration Key is found on the Organization Setup page of the secure website.
EntryIdStringThe unique identifier of the entry to which the requested file belongs.
FilenameStringThe 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


Response Body

The requested media file is returned.


    • Related Articles

    • GET Formentry

      GET Formentry The GET Formentry API returns the form entry matching 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 ...
    • GET Formentry

      TABLE OF CONTENTS Parameters Example The GET Formentry API returns the form entry matching 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 ...
    • GET Formentry (Search)

      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 ...
    • DELETE Formentry

      DELETE Formentry The DELETE Formentry API allows you to delete an existing form entry. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST DELETE verb. The format query string parameter controls the desired response ...
    • GET Task (Search)

      TABLE OF CONTENTS Parameters Example Additional Info API Explorer This request method allows you to find all tasks matching the given criteria. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format ...