Link (Legacy File)

This is a legacy type which works the same as the 'link' object, however for legacy reasons has different node names.

Structure

{
  "name": "Owner's on park agreement",
  "file": "https://your-wordpress-install.com/wp-content/uploads/2023/02/owners.pdf"
}

Properties

name

Type : String - Required

Name of file which should be used on the CTA button when rendering on a detail page

file

Type : Url String - Required

External url that the CTA button should try to externally open

Required Type Definitions

String - Reveal

Standard JSON String - Often will have certain characters escaped depending what system is writing the JSON packet, however our parser only requires to have double quotes (") escaped. UTF-8 encoding is our standard, but others may be accepted if required. If line breaks are required in the text then the Rich Text / Multiline String type is used instead.

{
  "key1": "A string value",
  "key2": "Another string with an some \"quotes\" that need escaping",
  "arrayOfStrings": [
    "Item one as a string",
    "Item two as a string",
    "Item three as a string",
  ] 
}

Url String - Reveal

A Url is sent the same as a string. If our system knows this is a url it will check if it starts with http or https - Note that navigating from both iOS and Android should use https.

{
  "bookingUrl" : "https://portal.managebooking.pmssystem"
}

Community