Place

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 value which should be a valid 24bit hexadecimal string. For example "#FF0000" for red. This is parsed by the app surfaces and defaults to a brand color if invalid.

{
  "color": "#FF00FF"
}

A single definition to define how far an entity is from your chosen park in miles and what the estimated car travel time is in minutes. Single site installs still require the site node and should say 'default' - multi park installs should use the groupsite key for this specific distance/travel time.

{
  "site": "park-one",
  "distance": 2.09,
  "time": 6
}

site

Type : String - Required

For single park installs this should be 'default' else it should be the groupsite key this data relates to

distance

Type : Floating Point Numeric - Optional

This is distance from the park in miles. App will truncate floating points to two when rendering. If both points are zero the app will render it as an integer. The app will also prefix with mile or miles. eg "3.25 miles", "1 mile", or "22 miles". Default is 0.0

time

Type : Integer - Optional

Estimated driving travel time to this location in minutes. This should be an integer as minutes but will be rendered as hrs/mins eg 126 = "2 hrs 6 mins", 58 = "58 mins", 61 = "1 hr 1 min". Default is 0

Float and Double values are handled as normal JSON. Depending on the precision of the language sending/receiving the data can depend on the truncation of the decimal points. However due to the context of our data, only location lat/lng numbers will normally have more than 2-3 points.

{
  "cost": 55.5,
  "lat": 50.71245750791539,
  "lng":  -2.4619866156242995
}

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

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

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

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

This is a single item for opening times if they are set to the 'timescopy' opening times type. Each one renders the heading in bold with the times in standard text. If a note is included it renders under that specific item in smaller text.

{
  "heading": "Fri - Sun",
  "times": "10.00 - 23.00",
  "note": "Last orders is 22:00"
}

heading

Type : String - Required

Bold heading of opening time row - eg 'Monday - Friday'

times

Type : String - Required

Standard text of opening time row eg '12noon - 5pm'

note

Type : Rich Text / Multiline String - Optional

Optional addition text to add after title/times

This is the full object for opening times. It may include just an opening times type, but may also include a selection of opening times text items to render.

{
  "openType": "timescopy",
  "textItems": [	
    {
      "heading": "Mon - Thurs",
      "times": "12.00 – 22.00"
    },
    {
      "heading": "Fri - Sun",
      "times": "10.00 - 23.00",
      "note": "Last orders is 22:00"
    }
  ]
}

openType

Type : Opening Times Type - Required

Type of opening times to render. Defaults to 'na'

textItems

Type : Array of Opening Time Text Item - Optional

If the open type is set to 'timescopy' this is a list of the text items to render. Each one includes a heading and times, with optional notes

notes

Type : Rich Text / Multiline String - Optional

Extra notes which is added after all of the times items are rendered, or it open type is set to always open

This is string definition to set how a menu item will behave. The options available are :
• "na" - Do not show opening times at all (default)
• "always" - Show opening times heading with 'Always Open' as a single item
• "timescopy" - Define specific opening times items

{
  "openType": "na"
}

A place alert box can create a callout highlight to both the place list items and the detail view. On the list item it will render an icon and heading in the style colors. If the list item heading is clicked it will trigger the intent if one has been set. On the detail view it will render as a card including title, icon and copy. If an intent is set a CTA button is added, and the highlight text option can give you a way of adding a large colour text view in the middle of this to highlight a promo code or similar.

{
  "style": "custom",
  "icon": "https://your-wordpress-install.com/wp-content/uploads/2021/08/red-tickets.png",
  "color": "#dd3333",
  "title": "Buy your event tickets in advance",
  "copy": "Discounted tickets available from Reception.",
  "highlightText": "Use code: APP10OFF",
  "linkIntent": "offer"
  "linkTitle": "Offer Details",
  "linkUrl": "",
  "linkID": 123
}

style

Type : Place Alert Style - Optional

Style of box. Defaults as 'standard'

icon

Type : Image Url String - Optional

Custom icon used beside title of the alert box if style is set to 'custom' - ignored by all other styles. This should be a small transparent png - 100-75px recommended

color

Type : Color String - Optional

Custom color used by the border and title of the alert box if style is set to 'custom' - ignored by all other styles

title

Type : String - Optional

Title is rendered either at the top of the alert box, or on the place list card in the style's defined color

copy

Type : Rich Text / Multiline String - Optional

Main copy rendered on alert box on detail view

highlightText

Type : String - Optional

This can be used for a promo code, or another small piece of text which is highlighted in large text with the styles color as the background

linkIntent

Type : Place Alert Intent - Optional

An optional internal app intent for the CTA button

linkUrl

Type : Url String - Optional

Optional url to add a CTA button for an external link (if present is used rather than the intent)

linkTitle

Type : String - Optional

If an intent or url is used, then this can be set for the text on the CTA button

linkID

Type : Integer - Optional

If intent is set to 'offer' or 'qikserve' then this is the id of the entity to navigate to, or to use

This is string definition to set a home alert's behaviour when the optional link is clicked. The options available are :
• "none" - No button (default)
• "whatson" - Navigate to What's On section
• "whatsonfilter" - Navigate to What's On section filtering to this specific place record
• "faqs" - Navigate to FAQs / Holiday Information section
• "map" - Navigate to Park Map - selecting this place record
• "offers" - Navigate to offers section
• "offer" - Navigate to offers section and view a specific offer record
• "qikserve" - Load chosen QikServe link within the app

{
  "linkIntent": "offer",
  "linkID": 134,
}

This is string definition to style a home alert. The options available are :
• "standard" - Info icon in branded color (default)
• "alert" - Warning/caution icon in red
• "takeaway" - Knife/Fork/Plate icon in green
• "custom" - Can set own icon/color

{
  "style": "takeaway"
}

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

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