Authorization Header
Base URL: get{
Header (Required):
Authorization: Basic {CompanyID}:{Username}:{Pwd}:{API Sync Key}
Content-Type: application/json
| Note | Authorization Header above is the same as all other F2B REST API calls. |
Get Sent Forms
Gets a list of Sent Forms for a Form Template ID along with additional parameters to refine the list.
Request: POST
https://fieldconnect.field2base.com/v2/api/onlinedocs/getsentformsSample Request (items in bold are required):
{
"templateId": "12345678-0000-0000-0000-123456789012",
"allUsers": "true", // optional, defaults to false "searchLimit": 1, // 1 is currently the only value supported
"includeUnreleased": "true", // optional, default is false
"minTimestamp": "2018-02-01T00:00:00-05:00", // optional
"maxTimestamp": "2018-02-28T00:00:00-05:00", // optional
"data": [ // optional, max regions is 3, possible search types: equals, startswith, endswith, contains
["Page1@FirstName","equals","John"],
["Page1@MiddleName","startswith","S"],
["Page1@LastNameName","endswith","Doe"]]
}NOTE: In order to use the "data" filtering option, Region Filters for the Form Template must first be created in the Portal (Admin > Form Templates > Region Filters) to capture the data.
Response: 200 OK
[
{
"ResourceId":"12345678-0000-0000-0000-123456789012",
"FriendlyName":"Form Title - Name: John S Doe DATE: 2/19/2018",
"RefNum":10000,
"RfiTimestamp":"2018-02-19T13:40:11.077"
}
]
Get Sent Form PDF
Retrieves rendered PDF of a Sent Form using a Resource where {resource id} is Resource GUID.
https://fieldconnect.field2base.com/v2/api/onlinedocs/sentforms/{resource id}/pdfResponse: 200 OK
PDF is returned as data in the contents of the body of the response with a content disposition of “inline”
Comments
0 comments
Please sign in to leave a comment.