POST api/v2/Prospects/Search

Search the Prospects Cross Reference.

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 ProspectSearchResult

Name	Type	Additional information
ProspectId	string	None.
Name	string	None.
Salesman	string	None.
DateEntered	string	None.
Status	string	None.
EmailAddress	string	None.
CustomerId	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ProspectId": "sample string 1",
    "Name": "sample string 2",
    "Salesman": "sample string 3",
    "DateEntered": "sample string 4",
    "Status": "sample string 5",
    "EmailAddress": "sample string 6",
    "CustomerId": "sample string 7"
  },
  {
    "ProspectId": "sample string 1",
    "Name": "sample string 2",
    "Salesman": "sample string 3",
    "DateEntered": "sample string 4",
    "Status": "sample string 5",
    "EmailAddress": "sample string 6",
    "CustomerId": "sample string 7"
  }
]

application/xml, text/xml

Sample:

<ArrayOfProspectSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <ProspectSearchResult>
    <CustomerId>sample string 7</CustomerId>
    <DateEntered>sample string 4</DateEntered>
    <EmailAddress>sample string 6</EmailAddress>
    <Name>sample string 2</Name>
    <ProspectId>sample string 1</ProspectId>
    <Salesman>sample string 3</Salesman>
    <Status>sample string 5</Status>
  </ProspectSearchResult>
  <ProspectSearchResult>
    <CustomerId>sample string 7</CustomerId>
    <DateEntered>sample string 4</DateEntered>
    <EmailAddress>sample string 6</EmailAddress>
    <Name>sample string 2</Name>
    <ProspectId>sample string 1</ProspectId>
    <Salesman>sample string 3</Salesman>
    <Status>sample string 5</Status>
  </ProspectSearchResult>
</ArrayOfProspectSearchResult>