POST 17.0/app/applicants/list

Description
Gets a list of Applicants that match the passed filters

URI Parameters
None.

ApplicantListFilters

Name	Type	Additional information
Categories	Collection of integer	None.
Usages	Collection of integer	None.
MarketPosition	Collection of integer	None.
Areas	Collection of integer	None.
PropertyTypes	Collection of integer	None.
PriceRange	NumberRange	None.
Bedrooms	NumberRange	None.
Sources	Collection of integer	None.
AssignedTo	Collection of integer	None.
Branches	Collection of integer	None.
FloorArea	NumberRange	None.
LandArea	NumberRange	None.

application/json, text/json

Sample:

{
  "categories": [
    1,
    2
  ],
  "usages": [
    1,
    2
  ],
  "marketPosition": [
    1,
    2
  ],
  "areas": [
    1,
    2
  ],
  "propertyTypes": [
    1,
    2
  ],
  "priceRange": {
    "min": 1.0,
    "max": 2.0
  },
  "bedrooms": {
    "min": 1.0,
    "max": 2.0
  },
  "sources": [
    1,
    2
  ],
  "assignedTo": [
    1,
    2
  ],
  "branches": [
    1,
    2
  ],
  "floorArea": {
    "min": 1.0,
    "max": 2.0
  },
  "landArea": {
    "min": 1.0,
    "max": 2.0
  }
}

application/xml, text/xml

Sample:

<ApplicantListFilters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Categories>
    <int>1</int>
    <int>2</int>
  </Categories>
  <Usages>
    <int>1</int>
    <int>2</int>
  </Usages>
  <MarketPosition>
    <int>1</int>
    <int>2</int>
  </MarketPosition>
  <Areas>
    <int>1</int>
    <int>2</int>
  </Areas>
  <PropertyTypes>
    <int>1</int>
    <int>2</int>
  </PropertyTypes>
  <PriceRange>
    <Min>1</Min>
    <Max>2</Max>
  </PriceRange>
  <Bedrooms>
    <Min>1</Min>
    <Max>2</Max>
  </Bedrooms>
  <Sources>
    <int>1</int>
    <int>2</int>
  </Sources>
  <AssignedTo>
    <int>1</int>
    <int>2</int>
  </AssignedTo>
  <Branches>
    <int>1</int>
    <int>2</int>
  </Branches>
  <FloorArea>
    <Min>1</Min>
    <Max>2</Max>
  </FloorArea>
  <LandArea>
    <Min>1</Min>
    <Max>2</Max>
  </LandArea>
</ApplicantListFilters>

application/x-www-form-urlencoded
Sample: Sample not available.

Collection of ApplicantListItem

Name	Type	Additional information
ContactID	integer	None.
FirstNames	string	None.
LastName	string	None.
HomeTelephone	string	None.
WorkTelephone	string	None.
Mobile	string	None.
AltTelephone	string	None.
TelephoneNumbers	string	None.
Category	IDDescriptionPair	None.
Beds	integer	None.
MinPrice	string	None.
MaxPrice	string	None.
MarketPosition	IDDescriptionPair	None.
AdditionalRequirements	string	None.
LastContactedDate	date	None.
DaysActive	integer	None.
MarketingPreferences	MarketingPreferences	None.

application/json, text/json

Sample:

[
  {
    "contactID": 1,
    "firstNames": "sample string 2",
    "lastName": "sample string 3",
    "homeTelephone": "sample string 4",
    "workTelephone": "sample string 5",
    "mobile": "sample string 6",
    "altTelephone": "sample string 7",
    "telephoneNumbers": "sample string 8",
    "category": {
      "id": 1,
      "description": "sample string 2"
    },
    "beds": 9,
    "minPrice": "sample string 10",
    "maxPrice": "sample string 11",
    "marketPosition": {
      "id": 1,
      "description": "sample string 2"
    },
    "additionalRequirements": "sample string 12",
    "lastContactedDate": "2025-01-09T20:34",
    "daysActive": 14,
    "marketingPreferences": {
      "post": true,
      "email": true,
      "smsText": true,
      "telephone": true,
      "passDetailsToThirdParties": true,
      "passDetailsToIFA": true,
      "passDetailsToConveyancer": true
    }
  },
  {
    "contactID": 1,
    "firstNames": "sample string 2",
    "lastName": "sample string 3",
    "homeTelephone": "sample string 4",
    "workTelephone": "sample string 5",
    "mobile": "sample string 6",
    "altTelephone": "sample string 7",
    "telephoneNumbers": "sample string 8",
    "category": {
      "id": 1,
      "description": "sample string 2"
    },
    "beds": 9,
    "minPrice": "sample string 10",
    "maxPrice": "sample string 11",
    "marketPosition": {
      "id": 1,
      "description": "sample string 2"
    },
    "additionalRequirements": "sample string 12",
    "lastContactedDate": "2025-01-09T20:34",
    "daysActive": 14,
    "marketingPreferences": {
      "post": true,
      "email": true,
      "smsText": true,
      "telephone": true,
      "passDetailsToThirdParties": true,
      "passDetailsToIFA": true,
      "passDetailsToConveyancer": true
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfApplicantListItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ApplicantListItem>
    <ContactID>1</ContactID>
    <FirstNames>sample string 2</FirstNames>
    <LastName>sample string 3</LastName>
    <HomeTelephone>sample string 4</HomeTelephone>
    <WorkTelephone>sample string 5</WorkTelephone>
    <Mobile>sample string 6</Mobile>
    <AltTelephone>sample string 7</AltTelephone>
    <TelephoneNumbers>sample string 8</TelephoneNumbers>
    <Category>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Category>
    <Beds>9</Beds>
    <MinPrice>sample string 10</MinPrice>
    <MaxPrice>sample string 11</MaxPrice>
    <MarketPosition>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </MarketPosition>
    <AdditionalRequirements>sample string 12</AdditionalRequirements>
    <LastContactedDate>2025-01-09T20:34:09.3970416+00:00</LastContactedDate>
    <DaysActive>14</DaysActive>
    <MarketingPreferences>
      <Post>true</Post>
      <Email>true</Email>
      <SmsText>true</SmsText>
      <Telephone>true</Telephone>
      <PassDetailsToThirdParties>true</PassDetailsToThirdParties>
      <PassDetailsToIFA>true</PassDetailsToIFA>
      <PassDetailsToConveyancer>true</PassDetailsToConveyancer>
    </MarketingPreferences>
  </ApplicantListItem>
  <ApplicantListItem>
    <ContactID>1</ContactID>
    <FirstNames>sample string 2</FirstNames>
    <LastName>sample string 3</LastName>
    <HomeTelephone>sample string 4</HomeTelephone>
    <WorkTelephone>sample string 5</WorkTelephone>
    <Mobile>sample string 6</Mobile>
    <AltTelephone>sample string 7</AltTelephone>
    <TelephoneNumbers>sample string 8</TelephoneNumbers>
    <Category>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </Category>
    <Beds>9</Beds>
    <MinPrice>sample string 10</MinPrice>
    <MaxPrice>sample string 11</MaxPrice>
    <MarketPosition>
      <ID>1</ID>
      <Description>sample string 2</Description>
    </MarketPosition>
    <AdditionalRequirements>sample string 12</AdditionalRequirements>
    <LastContactedDate>2025-01-09T20:34:09.3970416+00:00</LastContactedDate>
    <DaysActive>14</DaysActive>
    <MarketingPreferences>
      <Post>true</Post>
      <Email>true</Email>
      <SmsText>true</SmsText>
      <Telephone>true</Telephone>
      <PassDetailsToThirdParties>true</PassDetailsToThirdParties>
      <PassDetailsToIFA>true</PassDetailsToIFA>
      <PassDetailsToConveyancer>true</PassDetailsToConveyancer>
    </MarketingPreferences>
  </ApplicantListItem>
</ArrayOfApplicantListItem>

POST 17.0/app/applicants/list

Description

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml