GET [ api/forms/get-form-data-by-form-type ]
Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/v1/forms/get-form-data-by-form-type/{formTypeId}
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/v1/forms/get-form-data-by-form-type/{formTypeId}
Overview
Fetch all form data from passed form type id within staff person organisation, so the person can get all information related to forms for specific form type. This API can only be consumed by Staff Person with api_access & permitR
Authentication instructions
Refer to the Authentication method for Authentication Methods (for Login and Logout).
Permissions Required
The user required the permissions below:
API User
User is Staff
Permit R (Global or Any Project)
Please also refer to the Permissions Overview guide.
Query parameters
FIELD | TYPE | DESCRIPTION | REQUIRED | DEFAULT | PATTERN |
|
| Form Type ID | Yes |
|
|
|
| Form Created At From Date Filter | No |
|
|
|
| Form Created At To Date Filter | No |
|
|
|
| Contractor ID Filter | No |
|
|
|
| Site / Project ID Filter | No |
|
|
|
| Filter form record in given status List statuses constant number
| No |
|
|
Request Example
curl --location 'http://test.complyflow.com.au/app/public/index.php/api/forms/get-form-data-by-form-type/108' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]'Common requests and responses
Common requests and responses
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjI0MTUwLCJpc3MiOiJodHRwOi8vcmV5bmFsZC5jb21wbHlmbG93LmNvbS9hcHAvcHVibGljL2luZGV4LnBocC9hcGkvZm9ybXMvZ2V0LWZvcm0tZGF0YS1ieS1mb3JtLXR5cGUvMTU4IiwiaWF0IjoxNzI4MDY2NjIxLCJleHAiOjE3MjgwNzM4MjEsIm5iZiI6MTcyODA2NjYyMSwianRpIjoiZ25BM0JSNzhLN3Z4YXA0UiIsImlkIjoiUzg5MDIiLCJvcmdhbmlzYXRpb25faWQiOjk4MTh9.2kCdKMa7fGt6Crqmntzfq1GBdWuYMWUno7eQpaiMMR0",
"data": [
{
"form_id": 2315,
"description": "PT Sinar Jaya Registrasi",
"type": "Limited Liability Company Registration",
"site_id": 137,
"site": "Wo Long Lost Dynasty",
"organisation_name": "Coffee ORG",
"contractor_name": null,
"contractor_id": null,
"start_date": "23-01-2024 13:45",
"expiry_date": "29-02-2024 14:30",
"reviewed_by": [
{
"id": "8902",
"name": "Adam Kicinski"
}
],
"contact_person": [
{
"name": "Adam Kicinski",
"email": "cfdemo-rk-adamkicinski@complyflow.com"
}
],
"applicant": "Adam Kicinski",
"status": "Expired",
"questions": {
"Limited Liability Company Register": [
{
"id": 391,
"question": "Insurances",
"answer": null
},
{
"id": 392,
"question": "Does your Company have current $20M Public Liability Insurance valid in New Zealand?",
"answer": "Yes"
},
{
"id": 393,
"question": "Does your Company have current and valid ACC Cover?",
"answer": "No"
},
{
"id": 394,
"question": "If you provide engineering, design or consulting services you may require Professional indemnity insurance. If applicable do you have current and valid NZ Professional indemnity Insurance?",
"answer": "Yes"
},
{
"id": 395,
"question": "Please upload your Modern Slavery Statement",
"answer": "PQA3912/istockphoto-479986430-612x612.jpg"
},
{
"id": 396,
"question": "Text To Static Question",
"answer": null
}
]
}
},
]
}