List Prospects

Overview
Retrieve Prospect List of the client

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/prospect/list.html?token=XXXXXXXX&userId={userId}

Arguments

clientId required	MobiWork assigned unique ID of the company
versionNumber required	Version number of MobiWork API SDK release. Current version is: 10.0.78
token required	Part of URL as a request parameter and is required in every call to verify access to API calls
userId optional	If provided, this User ID will be taken as a logged in user

Filter or Search Criteria

firstName	By first name of prospect
name	By name of prospect
lastName	By last name of prospect

Return
Returns a list of Prospect Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 prospects will be returned. Returns an error if not a valid request

Request Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="request">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="firstName"/>
        <xs:element ref="lastName"/>
        <xs:element ref="name"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element> 
  <xs:element name="firstName" type="xs:string" minOccurs="0"/>
  <xs:element name="lastName" type="xs:string" minOccurs="0"/>
  <xs:element name="name" type="xs:NCName" minOccurs="0"/>
</xs:schema>

Response Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="prospectList"/>
      </xs:sequence>
      <xs:attribute name="statusCode" use="required" type="xs:integer"/>
      <xs:attribute name="version" use="required" type="xs:NMTOKEN"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="prospectList">
    <xs:complexType>
      <xs:sequence>
        <xs:element maxOccurs="unbounded" ref="prospect"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="prospect">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="prospectId"/>
        <xs:element ref="firstName"/>
        <xs:element ref="lastName"/>
        <xs:element ref="email"/>
        <xs:element ref="phone"/>
        <xs:element ref="countryId"/>
        <xs:element ref="expectedCloseDate"/>
        <xs:element ref="percentage"/>
        <xs:element ref="timeFrameTypeId"/>
        <xs:element ref="requestUri"/>
        <xs:element ref="lpCode"/>
        <xs:element ref="confirmed"/>
        <xs:element ref="confirmedDate"/>
        <xs:element ref="assignedTo"/>
        <xs:element ref="ipAddress"/>
        <xs:element ref="integrationStatus"/>
        <xs:element ref="address1"/>
        <xs:element ref="city"/>
        <xs:element ref="state"/>
        <xs:element ref="zipCode"/>
        <xs:element ref="title"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="prospectId" type="xs:integer"/>
  <xs:element name="firstName" type="xs:string"/>
  <xs:element name="lastName" type="xs:string"/>
  <xs:element name="email" type="xs:string"/>
  <xs:element name="phone">
    <xs:complexType/>
  </xs:element>
  <xs:element name="countryId" type="xs:integer"/>
  <xs:element name="expectedCloseDate">
    <xs:complexType/>
  </xs:element>
  <xs:element name="percentage" type="xs:integer"/>
  <xs:element name="timeFrameTypeId" type="xs:integer"/>
  <xs:element name="requestUri">
    <xs:complexType/>
  </xs:element>
  <xs:element name="lpCode">
    <xs:complexType/>
  </xs:element>
  <xs:element name="confirmed" type="xs:boolean"/>
  <xs:element name="confirmedDate">
    <xs:complexType/>
  </xs:element>
  <xs:element name="assignedTo" type="xs:integer"/>
  <xs:element name="ipAddress">
    <xs:complexType/>
  </xs:element>
  <xs:element name="integrationStatus">
    <xs:complexType/>
  </xs:element>
  <xs:element name="address1" type="xs:string"/>
  <xs:element name="city" type="xs:string"/>
  <xs:element name="state" type="xs:string"/>
  <xs:element name="zipCode" type="xs:string"/>
  <xs:element name="title" type="xs:string"/>
</xs:schema>

Curl Example

HTTP Method:	POST
Request:	curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/prospect/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data '<request><prospectType>RESIDENTIAL</prospectType><createdBy>Smith, John</createdBy></request>'
Response:	<?xml encoding="UTF-8" ?> <response version="10.0.78" statusCode="1"> <prospectList> <totalAvailableCount>55</totalAvailableCount> <count>55</count> <prospect> <entityId>1223587</entityId> <name>Test Prospect</name> <createdDate>09/17/2018 14:30:42</createdDate> <prospectId>1223587</prospectId> <firstName>Prospect First Name</firstName> <lastName>Prospect Last Name</lastName> <email>jdoe@gmail.com</email> </prospect>