GET api/v2/Prospects/RetrieveProspects?SalesmanId={SalesmanId}&LastUpdateDate={LastUpdateDate}&NewLeadsOnly={NewLeadsOnly}&NumbertoRetrieve={NumbertoRetrieve}

Select and Retrieves a collection of Prospect records based on supplied parameters.

Request Information

URI Parameters

Name	Description	Type	Additional information
SalesmanId	Optional: The SalesmanId to retreive leads for.	string	Default value is
LastUpdateDate	Optional: Retrieve leads modified on or after this date.	string	Default value is
NewLeadsOnly	Optional: True to retrieve only those leads that have not been retrieved before. False to retrieve all leads.	boolean	Default value is False
NumbertoRetrieve	Optional: The maximum number of leads to retrieve with each request.	integer	Default value is 100

Body Parameters

None.

Response Information

Resource Description

Collection of Prospect

Name	Type	Additional information
ProspectId	string	None.
CustomerId	string	None.
SalesMan	string	None.
LastName	string	None.
FirstName	string	None.
MiddleName	string	None.
Address1	string	None.
Address2	string	None.
City	string	None.
State	string	None.
Zip	string	None.
County	string	None.
Country	string	None.
Email	string	None.
Email2	string	None.
HomePhone	string	None.
MobilePhone	string	None.
BusinessPhone	string	None.
OtherPhone	string	None.
SourceCode	string	None.
LocationCode	string	None.
ForecastCode	string	None.
CategoryCode	string	None.
GeneralComments	string	None.
FollowUps	Collection of FollowUpAction	None.
WebLeads	Collection of WebLead	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ProspectId": "sample string 1",
    "CustomerId": "sample string 2",
    "SalesMan": "sample string 3",
    "LastName": "sample string 4",
    "FirstName": "sample string 5",
    "MiddleName": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "City": "sample string 9",
    "State": "sample string 10",
    "Zip": "sample string 11",
    "County": "sample string 12",
    "Country": "sample string 13",
    "Email": "sample string 14",
    "Email2": "sample string 15",
    "HomePhone": "sample string 16",
    "MobilePhone": "sample string 17",
    "BusinessPhone": "sample string 18",
    "OtherPhone": "sample string 19",
    "SourceCode": "sample string 20",
    "LocationCode": "sample string 21",
    "ForecastCode": "sample string 22",
    "CategoryCode": "sample string 23",
    "GeneralComments": "sample string 24",
    "FollowUps": [
      {
        "Date": "sample string 1",
        "SalesMan": "sample string 2",
        "Comments": "sample string 3"
      },
      {
        "Date": "sample string 1",
        "SalesMan": "sample string 2",
        "Comments": "sample string 3"
      }
    ],
    "WebLeads": [
      {
        "Key": "sample string 1",
        "DateReceived": "sample string 2",
        "DateSubmitted": "sample string 3",
        "Location": "sample string 4",
        "Source": "sample string 5",
        "Status": "sample string 6",
        "Industry": "sample string 7",
        "Type": "sample string 8",
        "Category": "sample string 9",
        "Comments": "sample string 10",
        "IntYear": "sample string 11",
        "IntMake": "sample string 12",
        "IntModel": "sample string 13",
        "IntStockNumber": "sample string 14",
        "IntLengthMin": "sample string 15",
        "IntLengthMax": "sample string 16",
        "IntProduct": "sample string 17",
        "IntURL": "sample string 18"
      },
      {
        "Key": "sample string 1",
        "DateReceived": "sample string 2",
        "DateSubmitted": "sample string 3",
        "Location": "sample string 4",
        "Source": "sample string 5",
        "Status": "sample string 6",
        "Industry": "sample string 7",
        "Type": "sample string 8",
        "Category": "sample string 9",
        "Comments": "sample string 10",
        "IntYear": "sample string 11",
        "IntMake": "sample string 12",
        "IntModel": "sample string 13",
        "IntStockNumber": "sample string 14",
        "IntLengthMin": "sample string 15",
        "IntLengthMax": "sample string 16",
        "IntProduct": "sample string 17",
        "IntURL": "sample string 18"
      }
    ]
  },
  {
    "ProspectId": "sample string 1",
    "CustomerId": "sample string 2",
    "SalesMan": "sample string 3",
    "LastName": "sample string 4",
    "FirstName": "sample string 5",
    "MiddleName": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "City": "sample string 9",
    "State": "sample string 10",
    "Zip": "sample string 11",
    "County": "sample string 12",
    "Country": "sample string 13",
    "Email": "sample string 14",
    "Email2": "sample string 15",
    "HomePhone": "sample string 16",
    "MobilePhone": "sample string 17",
    "BusinessPhone": "sample string 18",
    "OtherPhone": "sample string 19",
    "SourceCode": "sample string 20",
    "LocationCode": "sample string 21",
    "ForecastCode": "sample string 22",
    "CategoryCode": "sample string 23",
    "GeneralComments": "sample string 24",
    "FollowUps": [
      {
        "Date": "sample string 1",
        "SalesMan": "sample string 2",
        "Comments": "sample string 3"
      },
      {
        "Date": "sample string 1",
        "SalesMan": "sample string 2",
        "Comments": "sample string 3"
      }
    ],
    "WebLeads": [
      {
        "Key": "sample string 1",
        "DateReceived": "sample string 2",
        "DateSubmitted": "sample string 3",
        "Location": "sample string 4",
        "Source": "sample string 5",
        "Status": "sample string 6",
        "Industry": "sample string 7",
        "Type": "sample string 8",
        "Category": "sample string 9",
        "Comments": "sample string 10",
        "IntYear": "sample string 11",
        "IntMake": "sample string 12",
        "IntModel": "sample string 13",
        "IntStockNumber": "sample string 14",
        "IntLengthMin": "sample string 15",
        "IntLengthMax": "sample string 16",
        "IntProduct": "sample string 17",
        "IntURL": "sample string 18"
      },
      {
        "Key": "sample string 1",
        "DateReceived": "sample string 2",
        "DateSubmitted": "sample string 3",
        "Location": "sample string 4",
        "Source": "sample string 5",
        "Status": "sample string 6",
        "Industry": "sample string 7",
        "Type": "sample string 8",
        "Category": "sample string 9",
        "Comments": "sample string 10",
        "IntYear": "sample string 11",
        "IntMake": "sample string 12",
        "IntModel": "sample string 13",
        "IntStockNumber": "sample string 14",
        "IntLengthMin": "sample string 15",
        "IntLengthMax": "sample string 16",
        "IntProduct": "sample string 17",
        "IntURL": "sample string 18"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfProspect xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <Prospect>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <BusinessPhone>sample string 18</BusinessPhone>
    <CategoryCode>sample string 23</CategoryCode>
    <City>sample string 9</City>
    <Country>sample string 13</Country>
    <County>sample string 12</County>
    <CustomerId>sample string 2</CustomerId>
    <Email>sample string 14</Email>
    <Email2>sample string 15</Email2>
    <FirstName>sample string 5</FirstName>
    <FollowUps>
      <FollowUpAction>
        <Comments>sample string 3</Comments>
        <Date>sample string 1</Date>
        <SalesMan>sample string 2</SalesMan>
      </FollowUpAction>
      <FollowUpAction>
        <Comments>sample string 3</Comments>
        <Date>sample string 1</Date>
        <SalesMan>sample string 2</SalesMan>
      </FollowUpAction>
    </FollowUps>
    <ForecastCode>sample string 22</ForecastCode>
    <GeneralComments>sample string 24</GeneralComments>
    <HomePhone>sample string 16</HomePhone>
    <LastName>sample string 4</LastName>
    <LocationCode>sample string 21</LocationCode>
    <MiddleName>sample string 6</MiddleName>
    <MobilePhone>sample string 17</MobilePhone>
    <OtherPhone>sample string 19</OtherPhone>
    <ProspectId>sample string 1</ProspectId>
    <SalesMan>sample string 3</SalesMan>
    <SourceCode>sample string 20</SourceCode>
    <State>sample string 10</State>
    <WebLeads>
      <WebLead>
        <Category>sample string 9</Category>
        <Comments>sample string 10</Comments>
        <DateReceived>sample string 2</DateReceived>
        <DateSubmitted>sample string 3</DateSubmitted>
        <Industry>sample string 7</Industry>
        <IntLengthMax>sample string 16</IntLengthMax>
        <IntLengthMin>sample string 15</IntLengthMin>
        <IntMake>sample string 12</IntMake>
        <IntModel>sample string 13</IntModel>
        <IntProduct>sample string 17</IntProduct>
        <IntStockNumber>sample string 14</IntStockNumber>
        <IntURL>sample string 18</IntURL>
        <IntYear>sample string 11</IntYear>
        <Key>sample string 1</Key>
        <Location>sample string 4</Location>
        <Source>sample string 5</Source>
        <Status>sample string 6</Status>
        <Type>sample string 8</Type>
      </WebLead>
      <WebLead>
        <Category>sample string 9</Category>
        <Comments>sample string 10</Comments>
        <DateReceived>sample string 2</DateReceived>
        <DateSubmitted>sample string 3</DateSubmitted>
        <Industry>sample string 7</Industry>
        <IntLengthMax>sample string 16</IntLengthMax>
        <IntLengthMin>sample string 15</IntLengthMin>
        <IntMake>sample string 12</IntMake>
        <IntModel>sample string 13</IntModel>
        <IntProduct>sample string 17</IntProduct>
        <IntStockNumber>sample string 14</IntStockNumber>
        <IntURL>sample string 18</IntURL>
        <IntYear>sample string 11</IntYear>
        <Key>sample string 1</Key>
        <Location>sample string 4</Location>
        <Source>sample string 5</Source>
        <Status>sample string 6</Status>
        <Type>sample string 8</Type>
      </WebLead>
    </WebLeads>
    <Zip>sample string 11</Zip>
  </Prospect>
  <Prospect>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <BusinessPhone>sample string 18</BusinessPhone>
    <CategoryCode>sample string 23</CategoryCode>
    <City>sample string 9</City>
    <Country>sample string 13</Country>
    <County>sample string 12</County>
    <CustomerId>sample string 2</CustomerId>
    <Email>sample string 14</Email>
    <Email2>sample string 15</Email2>
    <FirstName>sample string 5</FirstName>
    <FollowUps>
      <FollowUpAction>
        <Comments>sample string 3</Comments>
        <Date>sample string 1</Date>
        <SalesMan>sample string 2</SalesMan>
      </FollowUpAction>
      <FollowUpAction>
        <Comments>sample string 3</Comments>
        <Date>sample string 1</Date>
        <SalesMan>sample string 2</SalesMan>
      </FollowUpAction>
    </FollowUps>
    <ForecastCode>sample string 22</ForecastCode>
    <GeneralComments>sample string 24</GeneralComments>
    <HomePhone>sample string 16</HomePhone>
    <LastName>sample string 4</LastName>
    <LocationCode>sample string 21</LocationCode>
    <MiddleName>sample string 6</MiddleName>
    <MobilePhone>sample string 17</MobilePhone>
    <OtherPhone>sample string 19</OtherPhone>
    <ProspectId>sample string 1</ProspectId>
    <SalesMan>sample string 3</SalesMan>
    <SourceCode>sample string 20</SourceCode>
    <State>sample string 10</State>
    <WebLeads>
      <WebLead>
        <Category>sample string 9</Category>
        <Comments>sample string 10</Comments>
        <DateReceived>sample string 2</DateReceived>
        <DateSubmitted>sample string 3</DateSubmitted>
        <Industry>sample string 7</Industry>
        <IntLengthMax>sample string 16</IntLengthMax>
        <IntLengthMin>sample string 15</IntLengthMin>
        <IntMake>sample string 12</IntMake>
        <IntModel>sample string 13</IntModel>
        <IntProduct>sample string 17</IntProduct>
        <IntStockNumber>sample string 14</IntStockNumber>
        <IntURL>sample string 18</IntURL>
        <IntYear>sample string 11</IntYear>
        <Key>sample string 1</Key>
        <Location>sample string 4</Location>
        <Source>sample string 5</Source>
        <Status>sample string 6</Status>
        <Type>sample string 8</Type>
      </WebLead>
      <WebLead>
        <Category>sample string 9</Category>
        <Comments>sample string 10</Comments>
        <DateReceived>sample string 2</DateReceived>
        <DateSubmitted>sample string 3</DateSubmitted>
        <Industry>sample string 7</Industry>
        <IntLengthMax>sample string 16</IntLengthMax>
        <IntLengthMin>sample string 15</IntLengthMin>
        <IntMake>sample string 12</IntMake>
        <IntModel>sample string 13</IntModel>
        <IntProduct>sample string 17</IntProduct>
        <IntStockNumber>sample string 14</IntStockNumber>
        <IntURL>sample string 18</IntURL>
        <IntYear>sample string 11</IntYear>
        <Key>sample string 1</Key>
        <Location>sample string 4</Location>
        <Source>sample string 5</Source>
        <Status>sample string 6</Status>
        <Type>sample string 8</Type>
      </WebLead>
    </WebLeads>
    <Zip>sample string 11</Zip>
  </Prospect>
</ArrayOfProspect>