Selection or filter parameters

REST Apis

Several APIs use selection parameters that allow you to refine your search.
These parameters are common because the API can give different results, but research can take place within a set of common interest, such as Sun sailboats, motor boats or Sun only used boats, etc...

Selection or filter parameters

share

Optional

 Requires only list ads.
  • 0 - Only those hidden (unpublished)
  • 1 - Only those personal website
  • 2 - Only those published on yacht4web
  • 3 - All ads
This option is useful to expose in a search form, only the types present in the currently available boats.
In order to avoid selecting a category not associated with no boat available.
md

Optional

 Only if used = 1
The types of the boats present a certain class
Allowed values are:
  • 1 - Motor boats ads
  • 2 - Listings for sailboats

Example

To get a list of types used in sailboat ads only add to request

&md=2
sec

Optional

 The types of the boats present a given sector (Use, Rental or new).
Allowed values are:
  • U - Only used boats
  • N - Only new boats
  • C - Only rental boats

Example

To get a list of types used in your own rental listings add to request

&sec=C