Skip to main content

Available Annexures

Description: To get a list of available annexures for a form, a HTTP GET request is made to the URL with the form's template version ID and a session token.

To determine if an annexure is attached to the form, you check for the annexure's ID in the annexure_template_ids field (or the annexure_pdf_ids field if the annexure is of the pdf type) returned from the get form endpoint.

info

If the site supports PDF annexures, both standard and PDF annexures will be returned by this endpoint.

Method: GET

URI:/template_versions/template_version_id/annexures

URI Parameters:

  • template_version_id: The template version ID for the form. This is returned when you get a form.

Headers: Authorization: Third party based authorization header

Returns

FieldTypeDescription
Array of AnnexuresAnnexureAn array of annexure objects.

Example

Request
curl https://app-api.reiformslive.com.au/template_versions/1/annexures \
--request GET \
--header "Authorization: Basic YTlkOWIwYItNGY4Yi1hYTQxLTI5NzZmMTcyZmEyMQ=="
Response
[
{
"id": 1,
"name": "Blank Annexure A",
"index": 10,
"auto": false,
"pdf": false,
"optional": true
},
{
"id": 2,
"name": "Blank Annexure B",
"index": 20,
"auto": false,
"pdf": false,
"optional": true
},
{
"id": 3,
"name": "Blank Annexure C",
"index": 30,
"auto": false,
"pdf": false,
"optional": true
},
{
"id": 1,
"name": "Foreign Transfer Duty Declaration",
"index": 100,
"auto": true,
"pdf": true,
"optional": true
}
]