The search API represents the most flexible and useful part of CIDS. It allows for the creation of a set of standard pages, for example:
Caribbean power yachts
West Mediterranean sailing yachts
As well as for more specific user generated queries.
The number of results to be displayed per page.
Requesting fewer results will improve service response times.
The page number you want returned e.g. (3rd page of 5).
currencyCode (ISO 4217)
The currency to be used based on ISO 4217 codes. We only use a limited set provided by the /currency service.
Your RYS Type so that we can determine which are your featured yachts.
The area that the yacht operates in. The /area service can be used to match the areaKey to a description.
The type of yacht.
The name or partial name of a specific yacht.
Minimum number of guests the yacht can accommodate.
Yacht must have windsurfing equipment.
Yacht must have kayaking equipment.
Yacht must have wave runners available.
Approximate charter start month to check availability and rates.
Approximate charter weekly rate.
Approximate charter weekly rate – uses rate to create a specific range of rates. If this is not specified 20% either side of rate will be used. Specifying “inf” denotes no upper limit.
Allows for alpha numeric separation easy navigation by users. List Sailing Yachts starting with A, for example.
Only yachts selected as featured for this RYS Type will be returned. rysType must be set correctly to use this feature or you may get unexpected results. If you do not get any results you should check to see that you have some featured yachts selected here.
Only return yachts that are in the fleet of the company linked to the given rysType. If no rysType is provided or the company does not have a fleet no yachts are returned.
Caribbean sailing yachts
Name begins with ‘b’, 8 guests and kayak
Available in Jan 2017 with wave runner and 12 guests
Featured yachts for given RYS type
Fleet yachts for given RYS type