POST api/v2/MarinaOps/Slips/Search
Search for slips base on provided criteria.
Request Information
URI Parameters
None.
Body Parameters
SearchArgs| 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 SlipSearchResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | string |
None. |
|
| Desc | string |
None. |
|
| Length | string |
None. |
|
| Width | string |
None. |
|
| BoatId | string |
None. |
|
| BoatName | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": "sample string 1",
"Desc": "sample string 2",
"Length": "sample string 3",
"Width": "sample string 4",
"BoatId": "sample string 5",
"BoatName": "sample string 6"
},
{
"Id": "sample string 1",
"Desc": "sample string 2",
"Length": "sample string 3",
"Width": "sample string 4",
"BoatId": "sample string 5",
"BoatName": "sample string 6"
}
]
application/xml, text/xml
Sample:
<ArrayOfSlipSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
<SlipSearchResult>
<BoatId>sample string 5</BoatId>
<BoatName>sample string 6</BoatName>
<Desc>sample string 2</Desc>
<Id>sample string 1</Id>
<Length>sample string 3</Length>
<Width>sample string 4</Width>
</SlipSearchResult>
<SlipSearchResult>
<BoatId>sample string 5</BoatId>
<BoatName>sample string 6</BoatName>
<Desc>sample string 2</Desc>
<Id>sample string 1</Id>
<Length>sample string 3</Length>
<Width>sample string 4</Width>
</SlipSearchResult>
</ArrayOfSlipSearchResult>