POST api/v2/Inventory/Search

Search the full inventory for an item.

Request Information

URI Parameters

None.

Body Parameters

The string you want to search for. Set Direct Hit to true if looking for a specific item.

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 InventorySearchResult

Name	Type	Additional information
PartId	string	None.
Description	string	None.
Price1	string	None.
QOH	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PartId": "sample string 1",
    "Description": "sample string 2",
    "Price1": "sample string 3",
    "QOH": "sample string 4"
  },
  {
    "PartId": "sample string 1",
    "Description": "sample string 2",
    "Price1": "sample string 3",
    "QOH": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfInventorySearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <InventorySearchResult>
    <Description>sample string 2</Description>
    <PartId>sample string 1</PartId>
    <Price1>sample string 3</Price1>
    <QOH>sample string 4</QOH>
  </InventorySearchResult>
  <InventorySearchResult>
    <Description>sample string 2</Description>
    <PartId>sample string 1</PartId>
    <Price1>sample string 3</Price1>
    <QOH>sample string 4</QOH>
  </InventorySearchResult>
</ArrayOfInventorySearchResult>