| Name | Description | Type | Additional information |
|---|---|---|---|
| searchString |
text to search for |
string |
None. |
| marinaCode |
Marina code to return results for. This can parameter can interact with other filters: includeInBoats/includeOutBoats - only boats in/out at the given marina are included. Otherwise, boats that are in/out at ANY marina are included. searchBerths - if a marina code is specified, then only berths at the given marina are included. Otherwise, berths at ANY marina are included. |
string |
None. |
| includeInBoats |
When TRUE, includes boats that are currently IN (see marinaCode parameter for more info). This only affects BOAT results. |
boolean |
None. |
| includeOutBoats |
When TRUE, includes boats that are currently OUT (see marinaCode parameter for more info). This only affects BOAT results. |
boolean |
None. |
| searchBoats |
When TRUE, search function will look at boat records when matching the search text. |
boolean |
None. |
| searchCustomers |
When TRUE, search function will look at customer records when matching the search text. |
boolean |
None. |
| searchBerths |
When TRUE, search function will look at berth records when matching the search text. |
boolean |
None. |
| resultsPerPage |
Number of results to return - 0 to disable pagination |
integer |
None. |
| pageNo |
The page number to return results from if pagination is enabled |
integer |
None. |