POST api/v2/Boats/Search

Search for Customer Boats based on provided criteria.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
SearchString	A string to search for in the Cross Reference. Name, Phone Number, Email, Boat Name, etc.	string	None.
DirectHit	Only return a result if only one matching record is found.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "SearchString": "sample string 1",
  "DirectHit": true
}

application/xml, text/xml

Sample:

<SearchArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <DirectHit>true</DirectHit>
  <SearchString>sample string 1</SearchString>
</SearchArgs>

Response Information

Resource Description

Collection of BoatSearchResult

Name	Type	Additional information
BoatId	string	None.
BoatName	string	None.
OwnerName	string	None.
ArrivalDate	string	None.
DepartureDate	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "BoatId": "sample string 1",
    "BoatName": "sample string 2",
    "OwnerName": "sample string 3",
    "ArrivalDate": "sample string 4",
    "DepartureDate": "sample string 5"
  },
  {
    "BoatId": "sample string 1",
    "BoatName": "sample string 2",
    "OwnerName": "sample string 3",
    "ArrivalDate": "sample string 4",
    "DepartureDate": "sample string 5"
  }
]

application/xml, text/xml

Sample:

<ArrayOfBoatSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <BoatSearchResult>
    <ArrivalDate>sample string 4</ArrivalDate>
    <BoatId>sample string 1</BoatId>
    <BoatName>sample string 2</BoatName>
    <DepartureDate>sample string 5</DepartureDate>
    <OwnerName>sample string 3</OwnerName>
  </BoatSearchResult>
  <BoatSearchResult>
    <ArrivalDate>sample string 4</ArrivalDate>
    <BoatId>sample string 1</BoatId>
    <BoatName>sample string 2</BoatName>
    <DepartureDate>sample string 5</DepartureDate>
    <OwnerName>sample string 3</OwnerName>
  </BoatSearchResult>
</ArrayOfBoatSearchResult>