API > Schema

Version: 1.02

Properties highlighted in red (example) are compulsory.

Guide to Structured Data

stayGB > Operator

The schema we use to identify data as it moves through our systems. Other properties will appear here such as checksums, timestamps and transfer references. These are not user editable. Any modification of these will cause data imports to bounce.

Property Type Description
GBid String Property used to identify a particular Local Business or Organization based in the UK and registered with us. This number is assigned by us and is unique to your business. Format GB-X, where X is a number between 100000 and 999999 (e.g. GB-100000 - GB-999999).
identifier Hash A hash used to identify update packages ensuring they belong to a particular business.

{
    "@context": "http://schema.staygb.org/Operator",
    "@type": "Operator",
    "GBid": "GB-999999",
    "identifier": "f9443c561f4adf7b0b48e95c433d68b2"
}

Organization or Local Business

The schemas we use to collect information about your business. This must conform to http://schema.org/Organization or http://schema.org/LocalBusiness whichever is most applicable. Please see http://schema.org for a complete reference. Only properties stated here will be read by our systems. Additional properties can be present but at this time will be ignored.

Property Type Description
address PostalAddress As defined by http://schema.org/PostalAddress. Properties read are: streetAddress, addressLocality, addressRegion, postalCode and addressCountry (GB accepted only).
ContactPoint ContactPoint As defined by http://schema.org/ContactPoint. Property read is telephone.
description String Description of business type.
email String The email address of your business. This is used as the destination of notification emails from the system in addition to customer enquiries. This is not made publicly available. The common addition of mailto: will be stripped.
image URL URL to an image which represents your business. Hostname must match that of the URL property.
legalName String The full registered legal name of your company.
logo URL Location where your Organization or business logo can be retrieved. Hostname must match that of the URL property. Logo must be square, maximum dimension of 300 pixels, set on white or transparent background and in the format of GIF or PNG.
name String The trading name of the Local Business or Organization.
sameAs URL or array of URLs URL(s) of pages associated to your business such as social networks and Wikipedia entry.
telephone String Telephone number. UK landline number starting 01 or 02. No mobile numbers will be accepted. Number to be presented in international E.164 format.
vatID String Your GB VAT number if applicable.
url URL Your website URL starting with http or https. Please note we will not pull updates from sites which are not completely served over SSL or have an invalid certificate. Check your server.
geo GeoCoordinates LocalBusiness ONLY. Supported properties are latitude and longitude.

{
    "@context": "http://schema.org",
    "@type": "Organization",
    "@id": "https://example.com/#organization",
    "name": "Example Boats",
    "legalName": "EXAMPLE BOATS LTD",
    "url": "https://example.com",
    "sameAs": [
        "https://twitter.com/example",
        "https://www.facebook.com/example"
    ],
    "logo": "https://example.com/brand/serp-logo.png",
    "description": "For brilliant boats and great customer service.",
    "address": {
        "@type": "PostalAddress",
        "streetAddress": "105 Round Hill",
        "addressLocality": "Leeds",
        "addressRegion": "West Yorkshire",
        "postalCode": "LS1 2BR",
        "addressCountry": "GB"
    },
    "email": "mailto:info@example.com",
    "contactPoint": {
        "@type": "ContactPoint",
        "telephone": "+441234567899",
        "contactType": "customer service",
        "areaServed": "GB",
        "availableLanguage": "English"
    }
}
{
    "@context": "http://schema.org",
    "@type": "LocalBusiness",
    "@id": "https://example.com/#localbusiness",
    "name": "Example Boats Ltd",
    "url": "https://example.com",
    "telephone": "+441234567899",
    "sameAs": [
        "https://twitter.com/example",
        "https://www.facebook.com/example"
    ],
    "logo": "https://example.com/brand/serp-logo.png",
    "description": "For brilliant boats and great customer service.",
    "address": {
        "@type": "PostalAddress",
        "streetAddress": "105 Round Hill",
        "addressLocality": "Leeds",
        "addressRegion": "West Yorkshire",
        "postalCode": "LS1 2BR",
        "addressCountry": "GB"
    },
    "geo": {
        "@type": "GeoCoordinates",
        "latitude": "40.00",
        "longitude": "73.00"
    }
}

stayGB > Boat

The schema we use to describe boats and watercraft.

Property Type Description
boatType String One of four values: motor Motor Boats; sail Sailing Boats; small Small Boats; equip Equipment.
manufacturer String Maker of the Boat thing.
model String Model of the boat.
mainPhoto String Filename or URL Main photograph of vessel. Filename conforming to [A-Za-z0-9\-]{1,12} with extension omitted or URL of file if import. Note that hostname must match business URL.
photos Array of filenames or URLs Extra photos of vessel. See mainphoto for rules.
name String The title displayed in search results. Generated automatically by combining manufacturer with model.
saleStatus Integer One of five values: 1 For Sale; 2 Under Offer; 3 SOLD; 4 Withdrawn; 5 Archived.
price Float The offer price of the item.
currency String The three letter currency code. Accepted values: GBP (default); USD; EUR.
vatStatus String Whether VAT is included in the listing price. Values accepted: y yes, VAT included; n no.
partXchange String Whether Part exchange / trade-in is possible. Values accepted: y yes; n no (default).
priceWas Float The original price of the item. Used when the price has been reduced so the item is shown as discounted.
loa Float The overall length of the vessel in metres.
beam Float The maximum width of the vessels hull in metres.
draft Float The vertical distance between the waterline and the bottom of the hull (keel) in metres.
airDraft Float The distance from the surface of the water to the highest point on the vessel in metres.
description String Introductory text for the vessel. Used in search. Maximum length 255 characters.
subType String More precise type to describe the vessel which if present may be displayed instead of boatType. Example a vessel in the Motor Boats type may be given the subType "Cabin Cruiser". Maximum length 25 characters.
berths Integer The number of people who can be accommodated to sleep on board the vessel.
cabins Integer The number of enclosed spaces (rooms) aboard the vessel.
toilets Integer The number of fitted toilets.
showers Integer The number of showers.
toiletType String The type of the toilets fitted. Examples: Sea; Tanked; Portable. Maximum length 15 characters.
accommodation String A description of the layout of the vessel and position of the berths and cabins. Maximum length 250 characters.
yearBuilt Integer The full year in which the hull was manufactured (e.g. 2017).
hullMaterial String The material from which the hull was manufactured. Typical values: GRP; Wood; Metal. Maximum length 20 characters.
superMaterial String The material from which the Super Structure was manufactured. Typical values: GRP; Wood; Metal. Maximum length 20 characters.
engineType String A description of the type of fitting of the engine. Typical values: Inboard shaft; Outboard; Inboard leg. Maximum length 20 characters.
fuel String Fuel used by the engine(s). Typical values: Petrol; Diesel; Electricity; LPG. Maximum length 20 characters.
numberEngines Integer The number of engines fitted.
engineHp Float The maximum horsepower of any single engine fitted.
engineManufacturer String Name of the engine manufacturer. Maximum length 25 characters.
galley String Maximum length 250 characters.
navigation String Navigation equipment. Maximum length 250 characters.
deckEquipment String Deck Equipment. Maximum length 250 characters.
sailgear String Sailing equipment and rigging. Maximum length 250 characters.
mechnElect String Mechanical and electrical equipment. Maximum length 250 characters.
safety String Safety equipment and systems. Maximum length 250 characters.
otherEquip String Rarely used. Maximum length 250 characters.
serviceHistory String Vessel Service history. Maximum length 250 characters.
updatedTime Integer Unix Timestamp in seconds indicating when the boat specification was last updated.

{
    "@context": "http://schema.staygb.org/Boat",
    "@type": "Boat",
    "version": "1.02",
    "boattype": "motor",
    "manufacturer": "Broom",
    "model": "42",
    "mainPhoto": "https://example.com/res/5437-main.jpg",
    "name": "Broom 42",
    "saleStatus": 1,
    "price": 32000,
    "priceWas": 35950,
    "currency": "GBP",
    "loa": 12.8,
    "description": "Recently refitted, this is a must see if you are in the market for a spacious cruiser."
}