POST 17.0/app/applicants/list/ids

Description

Gets applicant details based on the passed ids

URI Parameters

None.

Collection of integer

application/json, text/json
Sample: 
[
  1,
  2
]

application/xml, text/xml
Sample: 
<ArrayOfInt xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <int>1</int>
  <int>2</int>
</ArrayOfInt>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of ApplicantListItem
Name Description 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:40",
    "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:40",
    "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:40:12.0250326+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:40:12.0250326+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>