OpenMarineXML Version 2.0

From Wiki.openmarine.org

Contents 1 Introduction 2 XML Structure 3 XML Data Types 4 Pre-Set Tags 5 Optional Item Tags

[edit] Introduction

This page describes version 2 of the Open Marine Standard XML schema used for the export and import of brokers’ information between portals.

This version of the schema has not yet been released. It is shown here for the purposes of discussing upgrades to version 1.7 (the current release of the schema). You can view the current release here.

[edit] XML Structure

<?xml version="1.1" encoding="UTF-8" ?> 

<open_marine version="2.0" language="english" origin="MTM/YachtMarket/BoatsAndOutBoards" date="ISO 8601 time stamp"> 

  <broker code="">

    <broker_details>

      <company_name />

    </broker_details>

    <offices>

      <office id="">

        <office_name />

        <email />

        <name>

          <title />

          <forename />

          <surname />

        </name>

        <address />

        <town />

        <county />

        <country />

        <postcode />

        <daytime_phone />

        <evening_phone />

        <fax />

        <mobile />

        <website />

      </office>

    </offices>

    <adverts>

      <advert ref="" office_id="" status="Sold/Available/UnderOffer">

        <advert_media>

          <media type="MIME Media Type" caption="" primary="" />

        </advert_media>

        <advert_features>

          <boat_type />

          <boat_category />

          <new_or_used />

          <vessel_lying country="" />

          <asking_price poa="" currency="" vat_included="" />

          <marketing_descs>

            <marketing_desc language="" />

          </marketing_descs>

          <manufacturer />

          <model />

          <other>

            <item name="external_url" label="" />

          </other>

        </advert_features>

        <boat_features>

          <item name="boat_name" />

          <item name="owners_comment" />

          <item name="reg_details" />

          <item name="known_defects" />

          <item name="range" />

          <item name="last_serviced" />

          <item name="passenger_capacity" />

          <dimensions>

            <item name="beam" unit="metres/feet" />

            <item name="draft" unit="metres/feet" />

            <item name="loa" unit="metres/feet" />

            <item name="lwl" unit="metres/feet" />

            <item name="air_draft" unit="metres/feet" />

          </dimensions>

          <build>

            <item name="designer" />

            <item name="builder" />

            <item name="where" />

            <item name="year" />

            <item name="hull_colour" />

            <item name="hull_construction" />

            <item name="hull_number" />

            <item name="hull_type" />

            <item name="super_structure_colour" />

            <item name="super_structure_construction" />

            <item name="deck_colour" />

            <item name="deck_construction" />

            <item name="cockpit_type" />

            <item name="control_type" />

            <item name="flybridge" />

            <item name="keel_type" />

            <item name="ballast" units="kg/lbs/tonnes" /> 
            <item name="displacement" units="kg/lbs/tonnes" />

          </build>

          <galley>

            <item name="oven" />

            <item name="microwave" />

            <item name="fridge" />

            <item name="freezer" />

            <item name="heating" type="" />

            <item name="air_conditioning" />

          </galley>

          <engine>

            <item name="stern_thruster" />

            <item name="bow_thruster" />

            <item name="fuel" />

            <item name="hours" />

            <item name="cruising_speed" />

            <item name="max_speed" />

            <item name="horse_power" />

            <item name="engine_manufacturer" />

            <item name="engine_quantity" />

            <item name="tankage" unit="gallons/litres" />

            <item name="gallons_per_hour" />

            <item name="litres_per_hour" />

            <item name="engine_location" />

            <item name="gearbox" />

            <item name="cylinders" />

            <item name="propeller_type" />

            <item name="starting_type" />

            <item name="drive_type" />

            <item name="cooling_system" type="" />

         </engine>

         <navigation>

            <item name="navigation_lights" />

            <item name="compass" />

            <item name="depth_instrument" />

            <item name="wind_instrument" />

            <item name="autopilot" />

            <item name="gps" />

            <item name="vhf" />

            <item name="plotter" />

            <item name="speed_instrument" />

            <item name="radar" />

         </navigation>

         <accommodation>

            <item name="cabins" />

            <item name="berths" />

            <item name="toilet" />

            <item name="shower" />

            <item name="bath" />

         </accommodation>

         <safety_equipment>

            <item name="life_raft" capacity="" />

            <item name="epirb" />

            <item name="bilge_pump" />

            <item name="fire_extinguisher" type="C02/Water/foam" />

            <item name="mob_system" type="" />

         </safety_equipment>

         <rig_sails>

            <item name="genoa" material="" furling="" />

            <item name="spinnaker" material="" />

            <item name="tri_sail" material="" />

            <item name="storm_jib" material="" />

            <item name="main_sail" material="" />

            <item name="winches" />

         </rig_sails>

         <electronics>

            <item name="battery" />

            <item name="battery_charger" />

            <item name="generator" />

            <item name="inverter" />

         </electronics>

         <general>

            <item name="television" />

            <item name="cd_player" />

            <item name="dvd_player" />

         </general>

         <equipment>

            <item name="Anchor" />

            <item name="spray_hood" />

            <item name="Bimini" />

            <item name="fenders" />

         </equipment>

        </boat_features>

      </advert>

    </adverts>

  </broker>

</open_marine>

[edit] XML Data Types

The XML document’s tags are divided into two types, pre-set and item tags. Pre-set tags are named individually such as <company_name>, <email> etc. The inclusion of pre-set tags in the document should be mandatory although values of certain tags will be optional. However item tags inclusion in the document will be optional, this will allow for websites which do not support such fields in their adverts to omit tags and decrease file size allowing for faster transfer across the network.

Each node value and attribute value has a strict data type to prevent errors when sharing the data between portals. The following table details each node’s value and attributes datatype and gives a short description on the data to be entered.

Please note: pre-set and item tags have been selected from a generic list of boat and advert properties. If you would like to suggest a tag to be included in this document, please raise this in the discussion section of the wiki.

[edit] Pre-Set Tags

</tr>

Tag Name	Attributes	Value Data Type	Description
open_marine	version (double) language (string) origin (string) date (datetime)	None	The open_marine node identifies the document as an Open Marine standard data feed. The version attribute indicates which version of the standard the document conforms to. The language attribute will contain an ISO code indicating the language of the documents values*. The origin attribute will indicate the organisation supplying the data feed. Finally the date attribute will indicate the creation date of the document. The date attribute should conform to the ISO 8601 standard format ISO 8601 Info
broker	code (string)	None	The broker node is the container for all the broker’s contact details and adverts. This node can occur multiple times. The code attribute contains a unique code containing alpha numeric and or numeric characters used to identify the broker.
company_name	None	String	Indicates the broker’s company name
office	id (integer)	None	The office node is the container for the broker’s office contact details in a multiple office situation. This node can occur multiple times. The ID attribute contains a unique Identification number. This allows adverts to link to offices
office_name	None	String	Indicates the office’s name
email	None	String	Indicates the office’s email address
name	None	String	Indicates the office’s sales/marketing representative
address	None	String	Indicates the office’s street name
town	None	String	Indicates the office’s town
county	None	String	Indicates the office’s county
country	None	String	Indicates the office’s country
postcode	None	String	Indicates the office’s postcode
daytime_phone	None	String	Indicates the office’s daytime phone number
evening_phone	None	String	Indicates the office’s evening phone number
fax	None	String	Indicates the office’s fax number
mobile	None	String	Indicates the office’s mobile number
website	None	String	Indicates the office’s website address
advert	ref (string) office_id (integer) status (string)	None	The advert node is the container for all of the advert’s properties. This node can occur multiple times. The nodes ref attribute contains the adverts identification number. The nodes office_id attribute contains a numeric value indicating which office the advert bolongs to. In single office instances this attribute can be omitted. The status attribute indicates whether the advert is sold, under offer or available.
media	type (string) caption (string) primary (boolean)	String	The media node contains the location of aditional resources to accompany the advert such as an image or video files. The type attribute indicates the MIME media type that is being linked to, eg; application/x-shockwave-flash, image/gif, image/jpeg, video/mp4, video/quicktime, video/x-ms-wmv etc. For a complete listing please reference IANA. The caption attribute contains any text to describe the resource. The primary attribute is used to indicate whether the resource should stand out amongst many of a similar type.
boat_type	None	String	Indicates which boat class the advert belongs to. Possible values include sail, power, rib, etc
new_or_used	None	String	Indicates whether the boat is new or used
vessel_lying	country (string)	String	Indicates in which town the boat is currently lying. The country attribute indicates the country the town is situated.
asking_price	poa (Boolean) currency (string) vat_included (Boolean)	Integer	Indicates the price of the boat. This price can be inclusive or exclusive of VAT as this is indicated in the Vat_Included attribute with a value of True or False. Other attributes include POA (Price on Application) (True/False) and Which currency (ISO Code) the price should be displayed in.
marketing_desc	language (String)	String	Marketing description field. The language attribute will contain an ISO code indicating the language of the marketing description

[edit] Optional Item Tags

Item Tag Name	Attributes	Tag Value Data Type	Description
external_url	label (string)	String	Indicates an external web page containing further information concerning the advert. The label attribute should be used in place of the URL as the links text.
boat_name	None	String	Indicates the name of the boat
owners_comments	None	String	Current owner’s comments concerning the boat
reg_details	None	String	Details the boat’s Registration details
known_defects	None	String	Details any defects with the boat
max_speed	None	Integer	Indicates the maximum speed of the boat measured in Knots
range	None	Integer	Indicates the range of the engine indicated in nautical miles
cruising_speed	None	String	Indicates the cruising speed of the boat measured in Knots
last_serviced	None	Date	Indicates the date the boat was last serviced
beam	unit (string)	Integer	Indicates the Beam or Width of the boat. The measurement unit is shown in the Unit Attribute and and can have a value of either Metres or Feet.
draft	unit (string)	Integer	Indicates the Draft or the measurement the boat extends below the water. The measurement unit is shown in the Unit Attribute and can have a value of either Metres or Feet.
loa	unit (string)	Integer	Indicates the LOA (Length overall) of the boat. The measurement unit is shown in the Unit Attribute and can have a value of either Metres or Feet.
lwl	unit (string)	Integer	Indicates the LWL (Length water line) of the boat. The measurement unit is shown in the Unit Attribute and can have a value of either Metres or Feet.
air_draft	unit (string)	Integer	Indicates the Air Draft or the height of the boat measured from the water line to the top of the mast. The measurement unit is shown in the Unit Attribute and can have a value of either Metres or Feet.
designer	None	String	Indicates the name of the boat’s designer
builder	None	String	Indicates the name of the boat’s builder
where	None	String	Indicates where the boat was built
year	None	String	Indicates the year the boat was built
hull_colour	None	String	Indicates the colour of the hull
hull_construction	None	String	Indicates the hull’s construction material
hull_number	None	Integer	Indicates the hull’s serial number or Hull Identification Number (HIN) number
hull_type	None	String	Indicates type of hull the boat has
super_structure_colour	None	String	Indicates the colour of the super structure on the boat
super_structure_construction	None	String	Indicates the construction material of the super structure
deck_colour	None	String	Indicates the deck colour
deck_construction	None	String	Indicates the construction material of the deck
cockpit_type	None	String	Indicates the cockpit type
control_type	None	String	Indicates the control type
flybridge	None	Boolean	Indicates whether there is a flybridge on the boat
keel_type	None	String	Indicates the type of keel on the boat
displacement	unit (string)	String	Indicates the displacement or weight of the boat in the water. The measurement unit is shown in the Unit Attribute and can have a value of either Kgs, Lbs, Tons or Tonnes
oven	None	Boolean	Indicates whether a oven is included with the sale of the boat.
microwave	None	Boolean	Indicates whether a microwve is included with the sale of the boat.
fridge	None	Boolean	Indicates whether a fridge is included with the sale of the boat.
freezer	None	Boolean	Indicates whether a freezer is included with the sale of the boat.
heating	type (string)	Boolean	Indicates whether the boat has a heating system. The type attribute indicates the type of heating system if any.
air_conditioning	None	Boolean	Indicates whether the boat has air conditioning.
stern_thruster	None	Boolean	Indicates whether the boat has stern thrusters.
bow_thruster	None	Boolean	Indicates whether the boat has bow thrusters.
fuel	None	String	Indicates the type of fuel the engine uses
hours	None	Integer	Indicates the engine hours (how many hours the engine has run)
horse_power	None	Integer	Indicates the HP (Horse Power) of a single engine
engine_manufacturer	None	String	Indicates the engine manufacturer
engine_quantity	None	Integer	Indicates the number of engines
tankage	unit (String)	Integer	Details the combined fuel tank capacity. The measurement unit is shown in the Unit Attribute and can have a value of either gallons or litres
gallons_per_hour	None	Integer	Indicates the gallons per hour consumed
litres_per_hour	None	Integer	Indicates the litres per hour consumed
engine_Location	None	String	Indicates the location of the engine on the boat
gear_box	None	String	Indicates the type of gear box
cylinders	None	Integer	Indicates the number of cylinders in a single engine
propeller_type	None	String	Indicates the type of propeller
starting_type	None	String	Indicates the method used to start the engine
drive_type	None	String	Indicates the type of shaft used to drive the boat
cooling_system	type (String)	Boolean	Indicates whether the boat has a cooling system.
navigation_lights	None	Boolean	Indicates whether the boat has navigation lights.
compass	None	Boolean	Indicates whether the boat has a compass.
depth_instrument	None	Boolean	Indicates whether the boat has a depth instrument.
wind_instrument	None	Boolean	Indicates whether the boat has a wind instrument.
autopilot	None	Boolean	Indicates whether the boat has a auto pilot system.
gps	None	Boolean	Indicates whether the boat has a GPS system.
vhf	None	Boolean	Indicates whether the boat has a VHF radio.
plotter	None	Boolean	Indicates whether the boat has a plotter.
speed_instrument	None	Boolean	Indicates whether the boat has a speed instrument.
radar	None	Boolean	Indicates whether the boat has a radar.
cabins	None	Integer	Indicates the number of cabins
berths	None	Integer	Indicates the number of berths
toilet	None	Boolean	Indicates whether the boat has a toilet.
shower	None	Boolean	Indicates whether the boat has a shower.
bath	None	Boolean	Indicates whether the boat has a bath.
life_raft	capacity (integer)	Boolean	Indicates whether the boat has a life raft. The capacity attribute indicates the number of people the life raft can hold
epirb	None	Boolean	Indicates whether the boat has a Epirb system.
bilge_pump	None	Boolean	Indicates whether the boat has a bilge pump.
fire_extinguisher	type (string)	Boolean	Indicates whether the boat has a fire extinguisher. The type attribute indicates the contents of the fire extiniguisher for example CO2, Foam , Water etc.
mob_system	None	Boolean	Indicates whether the boat has a man over board system.
genoa	material (string) furling (Boolean)	Boolean	Indicates whether the boat has a genoa sail. The material attribute indicates the material the sail is made from. The furling attribute indicates whether the sail can be furled away.
spinnaker	material (string)	Boolean	Indicates whether the boat has a spinnaker sail. The material attribute indicates the material the sail is made from.
tri_Sail	material (string)	Boolean	Indicates whether the boat has a Tri Sail. The material attribute indicates the material the sail is made from.
storm_jib	material (string)	Boolean	Indicates whether the boat has a storm jib. The material attribute indicates the material the sail is made from.
main_sail	material (string)	Boolean	Indicates whether the boat has a main sail. The material attribute indicates the material the sail is made from.
winches	None	Integer	Indicates the number of winches on the boat.
battery	None	Boolean	Indicates whether the boat has a battery.
battery_charger	None	Boolean	Indicates whether the boat has a battery charger.
generator	None	Boolean	Indicates whether the boat has a generator.
inverter	None	Boolean	Indicates whether the boat has a inverer.
television	None	Boolean	Indicates whether the boat has a television.
cd_player	None	Boolean	Indicates whether the boat has a CD player
dvd_player	None	Boolean	Indicates whether the boat has a DVD player
anchor	None	Boolean	Indicates whether the boat has a anchor
spray_hood	None	Boolean	Indicates whether the boat has a spray hood
bimimi	None	Boolean	Indicates whether the boat has a bimini
fenders	None	Integer	Indicates the number of fenders included with the boat.
passenger_capacity	None	Integer	Indicates the number passengers the boat is able to carry.