Customer API

API change history

Form data poll

The Forms API polling endpoint allows your application to continually poll and process recently submitted standalone forms.
Integration:
This endpoint is designed to work out of the box with Microsoft Flow and Logic Apps as a “polling trigger” integration. Alternatively, you may choose to develop your own custom integration using any language.
Usage:
In a typical scenario, the first request to this endpoint should not provide any parameters. There are two possible successful responses:
HTTP Response code 200 - Recently submitted form records exist; response body will display form data.
HTTP Response code 202 – No recently submitted records exist; response body will be empty.
In both cases, there are two important headers in the response:
Location – The URL for the next request.
Retry-After – The recommended time interval in seconds for next request.
For example. if there is data to retrieve, the Retry-After header will have a value of 1 or 60. If there is no data to retrieve, the value of the Retry-After header will be


Note: These are just recommended values. Your application may choose to poll at a different frequency depending on your requirements. After the first request, all subsequent requests should use the URL provided in the Location header of the most recent response. No additional parameters should be added to the URL, as it already contains the necessary parameters required to ensure forms are not missing from the request.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    Format - date-time (as date-time in RFC3339). Date time in the format of yyyy-MM-ddTHH:mm:ss.ffZ.

  • (optional)
    integer

    Format - int64. FormHeaderId of the last record from previous request.

Request headers

  • (optional)
    integer

    CustomerAPI minor version

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

A list of forms data is returned in body as json string.

Response headers

  • (optional)
    string

    Time interval in seconds for next request in seconds

202 Accepted

No data to return since last time, and Retry-After = 300 (5 minutes).

400 Bad Request

Invalid request from the client. Examples: formHeaderId was passed in, but modifiedTime was not or formHeaderId data is earlier than 01/01/2000.

401 Unauthorized

Unauthorized request.

500 Internal Server Error

This error is always an indication of a bug on the server side, it possibly due to an unhandled exception.

Code samples

@ECHO OFF

curl -v -X GET "https://customerapi-encore.actsoft.com/forms/v1/poll?modifiedTime={string}&formHeaderId={integer}"
-H "X-API-Version: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("X-API-Version", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["modifiedTime"] = "{string}";
            queryString["formHeaderId"] = "{integer}";
            var uri = "https://customerapi-encore.actsoft.com/forms/v1/poll?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://customerapi-encore.actsoft.com/forms/v1/poll");

            builder.setParameter("modifiedTime", "{string}");
            builder.setParameter("formHeaderId", "{integer}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("X-API-Version", "");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "modifiedTime": "{string}",
            "formHeaderId": "{integer}",
        };
      
        $.ajax({
            url: "https://customerapi-encore.actsoft.com/forms/v1/poll?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("X-API-Version","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://customerapi-encore.actsoft.com/forms/v1/poll";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"modifiedTime={string}",
                         @"formHeaderId={integer}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"X-API-Version"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://customerapi-encore.actsoft.com/forms/v1/poll');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'X-API-Version' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'modifiedTime' => '{string}',
    'formHeaderId' => '{integer}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'X-API-Version': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'modifiedTime': '{string}',
    'formHeaderId': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("GET", "/forms/v1/poll?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'X-API-Version': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'modifiedTime': '{string}',
    'formHeaderId': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("GET", "/forms/v1/poll?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://customerapi-encore.actsoft.com/forms/v1/poll')

query = URI.encode_www_form({
    # Request parameters
    'modifiedTime' => '{string}',
    'formHeaderId' => '{integer}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['X-API-Version'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body