TABLE OF CONTENTS

  • Parameters
  • Example

 

ADDITIONAL INFO

  • API Explorer
  • General Information

 

 

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 format.  Specify either XML or JSON.


/api/v2/datasource?format=xml/json


Parameters

The GET verb allows you to return all the response data from any form submission matching the given parameters.


The required and optional parameters for a GET call to the Formentry 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.

 		 

✓

 
 

AnswerFormat

 		 

String

 		 

Whether or not to return rich answers or raw answers.

 
 

Id

 		 

String

 		 

The Form Entry's unique identifier.

 		 

✓

 
 

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.



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?AnswerFormat=Raw&CompanyId=XXXXX&IntegrationKey=a17a9bb385074a7591XXXXXXXX&&&&

 

Response Body 

{
  "Entry": {
    "Id": "930705bb09904fXXXXXXXXXXXX",
    "RowId": 1,
    "FormId": "59adbe4dc6b84XXXXXXXXXXXX",
    "FormVersion": 1,
    "DeviceId": "d7e5e330360c4edXXXXXXXXXXXX",
    "UserFirstName": "Griffin",
    "UserLastName": "Smith",
    "UserEmail": "XXXbox@amplusforms.com",
    "UserExternalId": "GameOn123",
    "Latitude": -82.74939,
    "Longitude": 81.780396,
    "StartTime": "2022-10-01T10:10:36.5070000Z",
    "CompleteTime": "2022-10-01T10:17:16.6670000Z",
    "ReceivedTime": "2022-10-01T10:17:17.5500000Z",
    "AnswerFormat": "Raw",
    "AnswersRawJson": {
      "page1": {
        "table": [
          {
            "nearestDate_DS": "",
            "id": "QCPAV6",
            "category": "A",
            "name": "QCP",
            "date": "2022-08-01T10:30:50Z",
            "btnNav1": "Add+"
          },
          {
            "nearestDate_DS": "",
            "id": "QP42H5",
            "category": "B",
            "name": "QP4",
            "date": "2022-07-02T10:30:59Z",
            "btnNav1": "Back^"
          },
          {
            "nearestDate_DS": "",
            "id": "6VNGN1",
            "category": "B",
            "name": "6VN",
            "date": "2022-06-02T10:30:16Z",
            "btnNav1": "Back^"
          },
          {
            "nearestDate_DS": "",
            "id": "8SIUYR",
            "category": "C",
            "name": "8SI",
            "date": "2022-05-03T10:30:28Z",
            "btnNav1": "Back^"
          },
          {
            "nearestDate_DS": "",
            "id": "J5S9EY",
            "category": "C",
            "name": "J5S",
            "date": "2022-04-03T10:30:48Z",
            "btnNav1": "Back^"
          },
          {
            "nearestDate_DS": "",
            "id": "1HPV4F",
            "category": "C",
            "name": "1HP",
            "date": "2022-03-03T10:30:08Z",
            "btnNav1": "Back^"
          }
        ]
      }
    },
    "DSRowId": "930705bb-0990-XXXXX-a890-XXXXXXXXXXX",
    "CompanyId": XXXXX
  }
}