Charter API Documentation

Introduction

Charter API is built using SOAP principles which ensures predictable URLs that makes writing applications easy. This API follows SOAP rules, enabling a wide range of HTTP clients to interact with the API. A more detailed documentation can be found here.

Locations

List all Marina locations
POST /GetLocations
Request XML Example
<?xml version="1.0"encoding="UTF-8"?><env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"xmlns:ns1="urn:ServiceControllerwsdl"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:enc="http://www.w3.org/2003/05/soap-encoding"><env:Body><ns1:GetLocationsWithBoatCount env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><broker_email xsi:type="xsd:string">[email protected]</broker_email><broker_password xsi:type="xsd:string">sailbook</broker_password></ns1:GetLocationsWithBoatCount></env:Body></env:Envelope>
                                                        
Response XML Example
<?xml version="1.0"encoding="UTF-8"?><env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"xmlns:ns1="urn:ServiceControllerwsdl"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:ns2="http://xml.apache.org/xml-soap"xmlns:enc="http://www.w3.org/2003/05/soap-encoding"><env:Body xmlns:rpc="http://www.w3.org/2003/05/soap-rpc"><ns1:GetLocationsResponse env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><rpc:result>return</rpc:result><return xsi:type="ns2:Map"><item><key xsi:type="xsd:string">AN_ANT</key><value xsi:type="xsd:string">Antigua, Antigua</value></item><item><key xsi:type="xsd:string">AU_AIR</key><value xsi:type="xsd:string">Airlie Beach, Australia</value></item><item><key xsi:type="xsd:string">BE_NIE</key><value xsi:type="xsd:string">Nieuwpoort, Belgium</value></item><item><key xsi:type="xsd:string">BR_ANG</key><value xsi:type="xsd:string">Angra dos Reis, Brazil</value></item><item><key xsi:type="xsd:string">BR_ROA</key><value xsi:type="xsd:string">Road Town, Tortola, British Virgin Islan</value></item><item><key xsi:type="xsd:string">CA_NAN</key><value xsi:type="xsd:string">Nanaimo, Vancouver Island, Canada</value></item><item><key xsi:type="xsd:string">CA_POW</key><value xsi:type="xsd:string">Powell River, Desolation Sound, Canada</value></item><item><key xsi:type="xsd:string">CA_SAO</key><value xsi:type="xsd:string">Sao Vincente, Cape Verde</value></item><item><key xsi:type="xsd:string">CA_SID</key><value xsi:type="xsd:string">Sidney, Vancouver Island, Canada</value></item><item><key xsi:type="xsd:string">CA_VAN</key><value xsi:type="xsd:string">Vancouver, Canada</value></item></return></ns1:GetLocationsResponse></env:Body></env:Envelope>
                                                        
Parsed Response Example
array (
AN_ANT => 'Antigua, Antigua',
AU_AIR => 'Airlie Beach, Australia',
BE_NIE => 'Nieuwpoort, Belgium',
BR_ANG => 'Angra dos Reis, Brazil',
BR_ROA => 'Road Town, Tortola, British Virgin Islan',
CA_NAN => 'Nanaimo, Vancouver Island, Canada',
CA_POW => 'Powell River, Desolation Sound, Canada',
CA_SAO => 'Sao Vincente, Cape Verde',
CA_SID => 'Sidney, Vancouver Island, Canada',
CA_VAN => 'Vancouver, Canada',
)
                                                        

My Locations

List Marina Locations of my Boats
ARGUMENTS
broker_email, Required (Email to login to Sail-Book)
broker_password, Required (Password to login to Sail-Book)
POST /GetMyLocations
Request XML Example
<?xml version="1.0"encoding="UTF-8"?><env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"xmlns:ns1="urn:ServiceControllerwsdl"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:enc="http://www.w3.org/2003/05/soap-encoding"><env:Body><ns1:GetMyLocations env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><broker_email xsi:type="xsd:string">[email protected]</broker_email><broker_password xsi:type="xsd:string">sail-book</broker_password></ns1:GetMyLocations></env:Body></env:Envelope>
                                                        
Response XML Example
<?xml version="1.0"encoding="UTF-8"?><env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"xmlns:ns1="urn:ServiceControllerwsdl"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:ns2="http://xml.apache.org/xml-soap"xmlns:enc="http://www.w3.org/2003/05/soap-encoding"><env:Body xmlns:rpc="http://www.w3.org/2003/05/soap-rpc"><ns1:GetMyLocationsResponse env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><rpc:result>return</rpc:result><return xsi:type="ns2:Map"><item><key xsi:type="xsd:string">GR_KAL</key><value xsi:type="xsd:string">Kalamaki, Athens, Greece</value></item><item><key xsi:type="xsd:string">GR_LAV</key><value xsi:type="xsd:string">Lavrion, Attica, Greece</value></item><item><key xsi:type="xsd:string">GR_GOU</key><value xsi:type="xsd:string">Marina Gouvia, Corfu, Greece</value></item><item><key xsi:type="xsd:string">GR_LEF</key><value xsi:type="xsd:string">Lefkas, Ionian, Greece</value></item><item><key xsi:type="xsd:string">GR_SKI</key><value xsi:type="xsd:string">Skiathos, Sporades, Greece</value></item><item><key xsi:type="xsd:string">GR_KOS</key><value xsi:type="xsd:string">Kos, Dodecanese, Greece</value></item><item><key xsi:type="xsd:string">GR_VOL</key><value xsi:type="xsd:string">Volos, Magnesia, Greece</value></item><item><key xsi:type="xsd:string">GR_MAN</key><value xsi:type="xsd:string">Marina Mandraki, Rhodes, Greece</value></item><item><key xsi:type="xsd:string">GR_PAR</key><value xsi:type="xsd:string">Paros, Cyclades, Greece</value></item><item><key xsi:type="xsd:string">GR_MYC</key><value xsi:type="xsd:string">Myconos, Cyclades, Greece</value></item><item><key xsi:type="xsd:string">TU_FET</key><value xsi:type="xsd:string">Fethiye,Turkey</value></item><
;item><key xsi:type="xsd:string">GR_GLY</key><value xsi:type="xsd:string">Glyfada, Athens, Greece</value></item><item><key xsi:type="xsd:string">GR_MIK</key><value xsi:type="xsd:string">Mikrolimano, Piraeus, Greece</value></item></return></ns1:GetMyLocationsResponse></env:Body></env:Envelope>
                                                        
Parsed Response Example
array (
GR_KAL  => 'Kalamaki, Athens, Greece'
GR_LAV  => 'Lavrion, Attica, Greece'
GR_GOU  => 'Marina Gouvia, Corfu, Greece'
GR_LEF  => 'Lefkas, Ionian, Greece'
GR_SKI  => 'Skiathos, Sporades, Greece'
GR_KOS  => 'Kos, Dodecanese, Greece'
GR_VOL  => 'Volos, Magnesia, Greece'
GR_MAN  => 'Marina Mandraki, Rhodes, Greece'
GR_PAR  => 'Paros, Cyclades, Greece'
GR_MYC  => 'Myconos, Cyclades, Greece'
GR_FET  => 'Fethiye,Turkey'
GR_GLY  => 'Glyfada, Athens, Greece'
GR_MIK  => 'Mikrolimano, Piraeus, Greece'
)
                                                        

Boat Types

List all Boat Types
POST /GetBoatTypes
Request XML Example
<?xml version="1.0" encoding="UTF-8"?> <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:ns1="urn:ServiceControllerwsdl" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:enc="http://www.w3.org/2003/05/soap-encoding"><env:Body><ns1:GetBoatTypes env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"/></env:Body></env:Envelope>
                                                        
Response XML Example
<?xml version="1.0" encoding="UTF-8"?> <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:ns1="urn:ServiceControllerwsdl" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns2="http://xml.apache.org/xml-soap" xmlns:enc="http://www.w3.org/2003/05/soap-encoding"><env:Body xmlns:rpc="http://www.w3.org/2003/05/soap-rpc"><ns1:GetBoatTypesResponse env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><rpc:result>return</rpc:result><return xsi:type="ns2:Map"><item><key xsi:type="xsd:int">1</key><value xsi:type="xsd:string">Sailing Yacht</value></item><item><key xsi:type="xsd:int">2</key><value xsi:type="xsd:string">Motor Yacht</value></item><item><key xsi:type="xsd:int">3</key><value xsi:type="xsd:string">Catamaran</value></item><item><key xsi:type="xsd:int">6</key><value xsi:type="xsd:string">Motor Sailer</value></item><item><key xsi:type="xsd:int">7</key><value xsi:type="xsd:string">Racing Yacht</value></item><item><key xsi:type="xsd:int">8</key><value xsi:type="xsd:string">Cruising Yacht</value></item><item><key xsi:type="xsd:int">9</key><value xsi:type="xsd:string">Mega Yacht</value></item></return></ns1:GetBoatTypesResponse></env:Body></env:Envelope>
                                                        
Parsed Response Example
array (
1 => 'Sailing Yacht',
2 => 'Motor Yacht',
3 => 'Catamaran',
6 => 'Motor Sailer',
7 => 'Racing Yacht',
8 => 'Cruising Yacht',
9 => 'Mega Yacht',
)
                                                        

My Boat Types

List all Boat Types of my Boats
ARGUMENTS
broker_email, Required (Email to login to Sail-Book)
broker_password, Required (Password to login to Sail-Book)
POST /GetMyBoatTypes
Request XML Example
<?xml version="1.0" encoding="UTF-8"?> <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:ns1="urn:ServiceControllerwsdl" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:enc="http://www.w3.org/2003/05/soap-encoding"><env:Body><ns1:GetMyBoatTypes env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"/><broker_email xsi:type="xsd:string">[email protected]</broker_email><broker_password xsi:type="xsd:string">sail-book</broker_password></ns1:GetMyBoatTypes></env:Body></env:Envelope>
                                                        
Response XML Example
<?xml version="1.0" encoding="UTF-8"?> <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:ns1="urn:ServiceControllerwsdl" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns2="http://xml.apache.org/xml-soap" xmlns:enc="http://www.w3.org/2003/05/soap-encoding"><env:Body xmlns:rpc="http://www.w3.org/2003/05/soap-rpc"><ns1:GetMyBoatTypesResponse env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><rpc:result>return</rpc:result><return xsi:type="ns2:Map"><item><key xsi:type="xsd:int">1</key><value xsi:type="xsd:string">Sailing Yacht</value></item><item><key xsi:type="xsd:int">3</key><value xsi:type="xsd:string">Catamaran</value></item><item><key xsi:type="xsd:int">7</key><value xsi:type="xsd:string">Racing Yacht</value></item><item><key xsi:type="xsd:int">2</key><value xsi:type="xsd:string">Motor Yacht</value></item><item><key xsi:type="xsd:int">6</key><value xsi:type="xsd:string">Motor Sailer</value></item><item><key xsi:type="xsd:int">9</key><value xsi:type="xsd:string">Mega Yacht</value></item></return></ns1:GetMyBoatTypesResponse></env:Body></env:Envelope>
                                                        
Parsed Response Example
array (
1 => 'Sailing Yacht',
3 => 'Catamaran',  
7 => 'Racing Yacht',  
2 => 'Motor Yacht',
6 => 'Motor Sailer',
9 => 'Mega Yacht',
)
                                                         

Skipper Types

List Types of Skipper
POST /GetSkipperTypes
Request XML Example
<?xml version="1.0"encoding="UTF-8"?> <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"xmlns:ns1="urn:ServiceControllerwsdl"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:enc="http://www.w3.org/2003/05/soap-encoding"><env:Body><ns1:GetSkipperTypes env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"/></env:Body></env:Envelope>
                                                        
Response XML Example
<?xml version="1.0"encoding="UTF-8"?> <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"xmlns:ns1="urn:ServiceControllerwsdl"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:xsd="http://www.w3.org/2001/XMLSchema"xmlns:ns2="http://xml.apache.org/xml-soap"xmlns:enc="http://www.w3.org/2003/05/soap-encoding"><env:Body xmlns:rpc="http://www.w3.org/2003/05/soap-rpc"><ns1:GetSkipperTypesResponse env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><rpc:result>return</rpc:result><return xsi:type="ns2:Map"><item><key xsi:type="xsd:int">1</key><value xsi:type="xsd:string">Skipper</value></item><item><key xsi:type="xsd:int">2</key><value xsi:type="xsd:string">Hostess</value></item></return></ns1:GetSkipperTypesResponse></env:Body></env:Envelope>
                                                        
Parsed Response Example
array (
1 => 'Skipper',
2 => 'Hostess',
)