/
finalized.html
36 lines (32 loc) · 1.44 KB
/
finalized.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
---
layout: default
navPage: docs
heading: Finalized Submissions
breadcrumbs:
- API,/api/
- API v1.x,/api/v1
- Finalized Submissions
prev: About the API,/api/
next: Debugging,/api/debugging/
versions: FT2
categories: api
tags: developer
---
{% include open_section.html nav='nav_api_v1.html' selected='finalized' nav_width=5 %}
<p>
When working with the API, there's one concept you should know about: <i>finalization</i>.
With the simple POST form submissions, submissions are immediately visible in the Form Tools
interface after the submissions is made. But with the API, it's a little more complicated.
You would want, for instance, incomplete submissions to appear in the Form Tools interface
before the user has completed all steps of the form. Similarly, what about people that
started filling in a form but never completed it? In those cases, you wouldn't want to see.
</p>
<p>
To get around this problem, when using the API, you need to explicitly finalize the
submissions. This is generally done on the final step of your form - or on the first, if you
have a one page form. You'll read more about finalization in the
<a href="{{site.baseurl}}/api/ft_api_process_form">ft_api_process_form()</a> function and
<a href="{{site.baseurl}}/api/ft_api_delete_unfinalized_submissions">ft_api_delete_unfinalized_submissions()</a>
functions. For now, it's enough that you understand the idea!
</p>
{% include close_section.html %}