Event

As we connect to different systems using a range of different languages, we can interpret several things as a true. Generally speaking holidaymaker will use a standard true/false JSON boolean, however we also read a lower case string and checked if they are "1", "true", "yes", or "on" to then create the positive boolean. Unless explicitly noted, all booleans are defaulted as false if the node doesn't exist.

{
  "optionOne": true,
  "optionTwo": false,
  "allTheseAreValidTrues" : [
    1, "1", true, "true", "on", "yes"
  ]
}

A string to dictate the rendering of the highlight tag on an event. If it is either of the two pre-set options then the app will render them using branded colors, else it will render whatever valid RGB value is sent. If neither of the preset values are sent, and the value is not a valid RGB hex code then it will render black.
• 'main' : This will render using the primary accent color used on cards/detail in the app
• 'alt' : This will render using the secondary accent color used on cards/detail in the app (often for owners only)
• Any other valid HEX RGB value will be rendered as sent

{
  //Use main / standard accent
  "highlightColor" : "main"

  //Use alt accent - often for owners only
  "highlightColor" : "alt"

  //Use your own custom color
  "highlightColor" : "#FF00FF"
}

A string to dictate the rendering of the highlight tag on an event. If it is either of the two pre-set options then the app will render them, else it will render whatever the text is sent as.
• 'default' : This will render the default options in Holidaymaker depending if the event is free or paid : "Free Activity" or "£ Activity"
• 'owners' : This will render the default option for the owners only tag : "Owner's only"
• Any thing else will be rendered as sent

{
  //Use default text
  "highlightText" : "default"

  //Use owners only text
  "highlightText" : "owners"

  //Use your own custom text
  "highlightText" : "One Night Only!"
}

Our app surfaces talk to an image engine on our infrastructure to process and resize images for different smart phone screen densities. Because of this the size of images are less relevant as they are delivered at optimum sizes anyway. However due to processing power and speed we do recommend that image urls are all 3000 pixels or below. The app surfaces will never need an image this large, so it gives you the option of still having a large quality image, but can be loaded in the apps and our infrastructure efficiently. We support both png, jpeg, and webp images. You can optionally include a '?v=' version integer so this can be used for versioning. If you do include this you can ensure images are reprocessed if the source image is changed on your servers.

{
  "imgUrl": "https://your-wordpress-site.com/wp-content/uploads/2023/08/a-large-image-3000x2100.jpg?v=1691481892",
  "image": "https://your-wordpress-site.com/wp-content/uploads/2023/08/a-smaller-image.png"
}

Standard JSON Integer - 0 is commonly considered to be a default value, unless it is an valid ID when -1 is used. For sort priorities 99 is used as the default.

{
  "key1": 9,
  "key2": 42,
  "arrayOfInts": [
    2,
    3,
    5,
    8
  ] 
}

A title and url of a link button. These are often attached to other entities to provide external links or pdf downloads such as onsite food menus, or more information about special offers.

{
  "url": "https:/your-wordpress-website.co.uk/wp-content/uploads/2021/08/offer-voucher.pdf",
  "title": "Download voucher"
}

url

Type : String - Required

Url to external link or pdf/doc attachment

title

Type : String - Required

Text for call to action button

This object are translations for language overrides on the base information for an event. These would be added to the event packet in an array keyed with the correct locale code.

{
  "title" : "Translated Title",
  "description" : "Translated list description for event.#BREAK#Can include breaks as normal",
  "content" : "Translated main copy for event.#BREAK#Can include breaks as normal",
  "highlightText" : "Translated Tag",
  "prices": "Translated Prices#BREAK#With Breaks",
  "timeText" : "10am - 4pm",
  "linksHeading" : "More Info Translation",
  "links" : [
    "Translated Title 1",
    "Translated Title 2"
  ]
}

title

Type : String - Optional

Translated Event Title

description

Type : Rich Text / Multiline String - Optional

Translated list description with can include breaks

content

Type : Markdown Text / Multiline String - Optional

Translated main copy with can include breaks and some basic markdown

highlightText

Type : String - Optional

Optional translated highlight text - Only relevant if highlight text is set to a custom value

prices

Type : Rich Text / Multiline String - Optional

Optional translated prices information with can include breaks

timeText

Type : String - Optional

Only required if the event is marked as all day, and has an custom all day time text. If english version is blank then a translated version of 'All Day' will be used anyway

linksHeading

Type : String - Optional

Only required if links heading if any have been set in the main record. Optional translation for the downloads / links heading. If english version is blank then a translated version of 'More information' will be used

links

Type : Array of String - Optional

A list of translation for the link buttons. Note this array should match up in order and size to the main record version. If not then the translations could be mismatched to the buttons. If there are more translations, the last entries will be discarded. If there are less translations, then the original language will be retained on the last entries.

Acts the same as a Rich Text / Multiline String (including using #BREAK# for new lines) however this text can include a limited set of MarkDown to allow rich formatting.
This includes :

*italic text* : Italic Text
**bold text** : Bold Text
***bold and italic text*** : Bold and Italic Text

• Bullet 1
- List of bullet points with hyphans or bullet character

1. Number Item 1
2. Numbered list of items with number and full stop

{
  "copy": "This paragraph will now have two line breaks, and then a list of bullets#BREAK##BREAK#• Bullet 1#BREAK#• Bullet 2#BREAK#• Bullet 3",
  "copyMarkdown": "This paragraph will now have two line breaks but with bits in **bold** and *italic*, and then a list of bullets#BREAK##BREAK#- Bullet 1#BREAK#- Bullet 2#BREAK#...and a numbered list...#BREAK#1. Number Item 1#BREAK#2. Number Item 2"
}

Acts the same as the standard String type, however If text is assumed to include line breaks then we use a place holder of #BREAK#. These will then be replaced by the relevant line breaks depending on the language, and device that is rendering the text. This is commonly used in entity copy, and addresses. Rich text should not include HTML or other markup. There should always be a contextual consideration as well - for example if you copy includes a html anchor link to 'Read More' - then simply removing the markup will then leave the text 'Read More' which will be a redundant, none clickable piece of text within the app surfaces.

{
  "textWithBullets": "This paragraph will now have two line breaks, and then a list of bullets#BREAK##BREAK#• Bullet 1#BREAK#• Bullet 2#BREAK#• Bullet 3",
  "address": "Holidaymaker App Ltd#BREAK#Stowey House#BREAK#Bridport Road#BREAK#Dorchester#BREAK#DT12SB"
}

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",
  ] 
}