GET api/prospect/{id}/{option}

Returns a set of Prospect records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'BySalepersonCode' - all prospect records for salesperson where id = SalepersonCode, 'BySalesDepartmentCode' - all prospects records for a sales department where id = SalesDepartmentCode,...

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required
option		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Prospect

Name	Description	Type	Additional information
ProspectId	Sedona internal autonumber for the Customer Site record	integer	None.
Contact	Name of contact	string	Required
CompanyName	Name of company where contact works	string	None.
Title		string	None.
Address1		string	None.
Address2		string	None.
Address3		string	None.
Geo1	City	string	None.
Geo2	State	string	None.
Geo2Short	State Abbrev	string	None.
Geo3	Zip	string	None.
Geo4		string	None.
Geo5		string	None.
CountryCode	Country code; must exist in the SS_Country table	string	None.
Phone1		string	None.
Phone2		string	None.
Mobile		string	None.
Pager		string	None.
Fax		string	None.
Email		string	None.
ExistingCustomerId	CustomerId of a customer already in the system	integer	None.
SourceCode	Value from SM_Source table; set to N/A if not applicable; list of valid options can be retrieved from GET: api/salessource	string	None.
SalespersonCode	Value from SY_Employee table; defaults to N/A if not supplied; list of valid options can be retrieved from GET: api/salesperson	string	String length: inclusive between 0 and 25
Salesperson2Code	Value from SY_Employee table; defaults to N/A if not supplied; list of valid options can be retrieved from GET: api/salesperson	string	String length: inclusive between 0 and 25
UserCode	the user making this change; defaults to UserCode value from config file if not set explicitly	string	None.
ReferralCustomerId	CustomerId for a customer who referered the prospect	integer	None.
FollowUpDate		date	None.
StatusCode		string	None.
IsCommercial		boolean	None.
SalesDepartmentCode	Value from SY_Department table; set to N/A if not applicable; list of valid options can be retrieved from GET: api/department	string	None.
Note		string	None.
Inactive		boolean	None.
OldProspectId		integer	None.
SecondSourceCode	Value from SM_Source table; set to N/A if not applicable; list of valid options can be retrieved from GET: api/salessource	string	None.
ResolutionCode	Value from OE_Resolution table; set to N/A if not applicable; list of valid options can be retrieved from GET: api/resolution	string	None.
ResolutionDate	Date of the resolution	date	None.
MasterAccountCode	Master Account Number this prospect should be under; value from AR_Master_Account table; set to N/A for regular customers; list of valid options can be retrieved from GET: api/masteraccount	string	None.
ServiceTicketId	Foreign key from SV_Service_Ticket	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ProspectId": 1,
    "Contact": "sample string 2",
    "CompanyName": "sample string 3",
    "Title": "sample string 4",
    "Address1": "sample string 5",
    "Address2": "sample string 6",
    "Address3": "sample string 7",
    "Geo1": "sample string 8",
    "Geo2": "sample string 9",
    "Geo2Short": "sample string 10",
    "Geo3": "sample string 11",
    "Geo4": "sample string 12",
    "Geo5": "sample string 13",
    "CountryCode": "sample string 14",
    "Phone1": "sample string 15",
    "Phone2": "sample string 16",
    "Mobile": "sample string 17",
    "Pager": "sample string 18",
    "Fax": "sample string 19",
    "Email": "sample string 20",
    "ExistingCustomerId": 1,
    "SourceCode": "sample string 21",
    "SalespersonCode": "sample string 22",
    "Salesperson2Code": "sample string 23",
    "UserCode": "sample string 24",
    "ReferralCustomerId": 1,
    "FollowUpDate": "2025-10-26T21:48:36.6209634-05:00",
    "StatusCode": "sample string 25",
    "IsCommercial": true,
    "SalesDepartmentCode": "sample string 27",
    "Note": "sample string 28",
    "Inactive": true,
    "OldProspectId": 1,
    "SecondSourceCode": "sample string 30",
    "ResolutionCode": "sample string 31",
    "ResolutionDate": "2025-10-26T21:48:36.6209634-05:00",
    "MasterAccountCode": "sample string 32",
    "ServiceTicketId": 1
  },
  {
    "ProspectId": 1,
    "Contact": "sample string 2",
    "CompanyName": "sample string 3",
    "Title": "sample string 4",
    "Address1": "sample string 5",
    "Address2": "sample string 6",
    "Address3": "sample string 7",
    "Geo1": "sample string 8",
    "Geo2": "sample string 9",
    "Geo2Short": "sample string 10",
    "Geo3": "sample string 11",
    "Geo4": "sample string 12",
    "Geo5": "sample string 13",
    "CountryCode": "sample string 14",
    "Phone1": "sample string 15",
    "Phone2": "sample string 16",
    "Mobile": "sample string 17",
    "Pager": "sample string 18",
    "Fax": "sample string 19",
    "Email": "sample string 20",
    "ExistingCustomerId": 1,
    "SourceCode": "sample string 21",
    "SalespersonCode": "sample string 22",
    "Salesperson2Code": "sample string 23",
    "UserCode": "sample string 24",
    "ReferralCustomerId": 1,
    "FollowUpDate": "2025-10-26T21:48:36.6209634-05:00",
    "StatusCode": "sample string 25",
    "IsCommercial": true,
    "SalesDepartmentCode": "sample string 27",
    "Note": "sample string 28",
    "Inactive": true,
    "OldProspectId": 1,
    "SecondSourceCode": "sample string 30",
    "ResolutionCode": "sample string 31",
    "ResolutionDate": "2025-10-26T21:48:36.6209634-05:00",
    "MasterAccountCode": "sample string 32",
    "ServiceTicketId": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfProspect xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <Prospect>
    <Address1>sample string 5</Address1>
    <Address2>sample string 6</Address2>
    <Address3>sample string 7</Address3>
    <CompanyName>sample string 3</CompanyName>
    <Contact>sample string 2</Contact>
    <CountryCode>sample string 14</CountryCode>
    <Email>sample string 20</Email>
    <ExistingCustomerId>1</ExistingCustomerId>
    <Fax>sample string 19</Fax>
    <FollowUpDate>2025-10-26T21:48:36.6209634-05:00</FollowUpDate>
    <Geo1>sample string 8</Geo1>
    <Geo2>sample string 9</Geo2>
    <Geo2Short>sample string 10</Geo2Short>
    <Geo3>sample string 11</Geo3>
    <Geo4>sample string 12</Geo4>
    <Geo5>sample string 13</Geo5>
    <Inactive>true</Inactive>
    <IsCommercial>true</IsCommercial>
    <MasterAccountCode>sample string 32</MasterAccountCode>
    <Mobile>sample string 17</Mobile>
    <Note>sample string 28</Note>
    <OldProspectId>1</OldProspectId>
    <Pager>sample string 18</Pager>
    <Phone1>sample string 15</Phone1>
    <Phone2>sample string 16</Phone2>
    <ProspectId>1</ProspectId>
    <ReferralCustomerId>1</ReferralCustomerId>
    <ResolutionCode>sample string 31</ResolutionCode>
    <ResolutionDate>2025-10-26T21:48:36.6209634-05:00</ResolutionDate>
    <SalesDepartmentCode>sample string 27</SalesDepartmentCode>
    <Salesperson2Code>sample string 23</Salesperson2Code>
    <SalespersonCode>sample string 22</SalespersonCode>
    <SecondSourceCode>sample string 30</SecondSourceCode>
    <ServiceTicketId>1</ServiceTicketId>
    <SourceCode>sample string 21</SourceCode>
    <StatusCode>sample string 25</StatusCode>
    <Title>sample string 4</Title>
    <UserCode>sample string 24</UserCode>
  </Prospect>
  <Prospect>
    <Address1>sample string 5</Address1>
    <Address2>sample string 6</Address2>
    <Address3>sample string 7</Address3>
    <CompanyName>sample string 3</CompanyName>
    <Contact>sample string 2</Contact>
    <CountryCode>sample string 14</CountryCode>
    <Email>sample string 20</Email>
    <ExistingCustomerId>1</ExistingCustomerId>
    <Fax>sample string 19</Fax>
    <FollowUpDate>2025-10-26T21:48:36.6209634-05:00</FollowUpDate>
    <Geo1>sample string 8</Geo1>
    <Geo2>sample string 9</Geo2>
    <Geo2Short>sample string 10</Geo2Short>
    <Geo3>sample string 11</Geo3>
    <Geo4>sample string 12</Geo4>
    <Geo5>sample string 13</Geo5>
    <Inactive>true</Inactive>
    <IsCommercial>true</IsCommercial>
    <MasterAccountCode>sample string 32</MasterAccountCode>
    <Mobile>sample string 17</Mobile>
    <Note>sample string 28</Note>
    <OldProspectId>1</OldProspectId>
    <Pager>sample string 18</Pager>
    <Phone1>sample string 15</Phone1>
    <Phone2>sample string 16</Phone2>
    <ProspectId>1</ProspectId>
    <ReferralCustomerId>1</ReferralCustomerId>
    <ResolutionCode>sample string 31</ResolutionCode>
    <ResolutionDate>2025-10-26T21:48:36.6209634-05:00</ResolutionDate>
    <SalesDepartmentCode>sample string 27</SalesDepartmentCode>
    <Salesperson2Code>sample string 23</Salesperson2Code>
    <SalespersonCode>sample string 22</SalespersonCode>
    <SecondSourceCode>sample string 30</SecondSourceCode>
    <ServiceTicketId>1</ServiceTicketId>
    <SourceCode>sample string 21</SourceCode>
    <StatusCode>sample string 25</StatusCode>
    <Title>sample string 4</Title>
    <UserCode>sample string 24</UserCode>
  </Prospect>
</ArrayOfProspect>