Skip to main content

Templates


Get Templates#

Description: To get a list of templates, a HTTP GET request is made to the URL with the session token.

Method: GET

URI: /templates/

Headers: Authorization: Third party based authorization header

Returns

FieldTypeDescription
costIntegerMonetary value of template specified in cents.
activeBooleanReturns true if the user template is active.
idIntegerUnique ID of the template.
nameStringName of the template.
codeStringCode of the template.
template_group_idIntegerTemplate group ID.

Example

Request
curl https://app-api.reiformslive.com.au/templates \
--request GET \
--header "Authorization: Basic YTlkOWIwYItNGY4Yi1hYTQxLTI5NzZmMTcyZmEyMQ=="
Response
[
{
"id": 1,
"name": "Sales Forms",
"active": true,
"index": 1,
"type": "SA",
"templates": [
{
"cost": 90,
"active": true,
"id": 65,
"name": "Agency Agreement 1",
"code": "0000001",
"template_group_id": 1
}
]
},
{
"id": 2,
"name": "Property Management Forms",
"active": true,
"index": 2,
"type": "FM",
"templates": [
{
"cost": 35,
"active": true,
"id": 64,
"name": "Agency Agreement 2",
"code": "0000002",
"template_group_id": 2
}
]
}
]

Get Single Template#

Description: To get a single template a HTTP GET request is made to the URL with the session token.

Method: GET

URI: /templates/template_id

URI: /template_versions/template_version_id

Headers: Authorization: Third party based authorization header

Returns

FieldTypeDescription
templateTemplateAn template object.
template_versionVersionA template version object.
fieldsFieldsA template fields object.

Example

Request
curl https://app-api.reiformslive.com.au/templates \
--request GET \
--header "Authorization: Basic YTlkOWIwYItNGY4Yi1hYTQxLTI5NzZmMTcyZmEyMQ=="
Response
{
"template": {
"id": 1,
"name": "Condition Report",
"code": "CR0000",
"active": true,
"orientation": "landscape",
"template_group_id": 2,
"name_test": null,
"created": 1348709689,
"updated": 1348709689
},
"template_version": {
"id": 2,
"template_id": 2,
"cost": 10,
"created": 1348709690,
"updated": 1348709690,
"user_guide_pages": 0,
"instruction_pages": 0
},
"fields": [
{
"display_name": "Agent Name",
"name": "Agent_Name",
"locked": true,
"required": false
},
{
"display_name": "Agent Mobile",
"name": "Agent_Phone_Mobile",
"locked": false,
"required": false
},
{
"display_name": "Agent Email",
"name": "Agent_Email",
"locked": false,
"required": false
}
]
}