GET crm/applicant?lastname={lastname}&postcode={postcode}&email={email}&telephone={telephone}&page={page}&pagesize={pagesize}
Returns applicant by last name, postcode, email and telephone
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| lastname | string |
Required |
|
| postcode | string |
Required |
|
| string |
Required |
||
| telephone | string |
Required |
|
| page | integer |
Default value is 1 |
|
| pagesize | integer |
Default value is 100 |
Body Parameters
None.
Response Information
Resource Description
Returns list of 100 applicants per page that satisfy search criteria sorted to show the most recent first
ERP.Api.Models.CRM.ApplicantSearchModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Applicants |
Collection of Applicants that returned by the search |
Collection of ERP.Api.Models.CRM.ApplicantModel |
None. |
| TotalCount |
Total number of resulting Applicants |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"applicants": [
{
"foreName": "sample string 1",
"surname": "sample string 2",
"dateOfBirth": "2025-01-18",
"email": "sample string 4",
"currentAddress": {
"flat": "sample string 1",
"buildingNumber": "sample string 2",
"buildingName": "sample string 3",
"street": "sample string 4",
"town": "sample string 5",
"county": "sample string 6",
"postcode": "sample string 7",
"status": {
"key": ""
},
"startDate": "2025-01-18",
"endDate": "2025-01-18"
},
"previousAddresses": [
{
"flat": "sample string 1",
"buildingNumber": "sample string 2",
"buildingName": "sample string 3",
"street": "sample string 4",
"town": "sample string 5",
"county": "sample string 6",
"postcode": "sample string 7",
"status": {
"key": ""
},
"startDate": "2025-01-18",
"endDate": "2025-01-18"
},
{
"flat": "sample string 1",
"buildingNumber": "sample string 2",
"buildingName": "sample string 3",
"street": "sample string 4",
"town": "sample string 5",
"county": "sample string 6",
"postcode": "sample string 7",
"status": {
"key": ""
},
"startDate": "2025-01-18",
"endDate": "2025-01-18"
}
],
"bankDetails": {
"accountName": "sample string 1",
"sortCode": "sample string 2",
"accountNumber": "sample string 3",
"dateOpened": "2025-01-18",
"bankName": "sample string 4"
},
"id": 5
},
{
"foreName": "sample string 1",
"surname": "sample string 2",
"dateOfBirth": "2025-01-18",
"email": "sample string 4",
"currentAddress": {
"flat": "sample string 1",
"buildingNumber": "sample string 2",
"buildingName": "sample string 3",
"street": "sample string 4",
"town": "sample string 5",
"county": "sample string 6",
"postcode": "sample string 7",
"status": {
"key": ""
},
"startDate": "2025-01-18",
"endDate": "2025-01-18"
},
"previousAddresses": [
{
"flat": "sample string 1",
"buildingNumber": "sample string 2",
"buildingName": "sample string 3",
"street": "sample string 4",
"town": "sample string 5",
"county": "sample string 6",
"postcode": "sample string 7",
"status": {
"key": ""
},
"startDate": "2025-01-18",
"endDate": "2025-01-18"
},
{
"flat": "sample string 1",
"buildingNumber": "sample string 2",
"buildingName": "sample string 3",
"street": "sample string 4",
"town": "sample string 5",
"county": "sample string 6",
"postcode": "sample string 7",
"status": {
"key": ""
},
"startDate": "2025-01-18",
"endDate": "2025-01-18"
}
],
"bankDetails": {
"accountName": "sample string 1",
"sortCode": "sample string 2",
"accountNumber": "sample string 3",
"dateOpened": "2025-01-18",
"bankName": "sample string 4"
},
"id": 5
}
],
"totalCount": 1
}
application/xml, text/xml
Sample:
<ApplicantSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models.CRM">
<Applicants>
<ApplicantModel>
<Id xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models">5</Id>
<BankDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/ERP.Domain.CRM.Applicant">
<d4p1:AccountName>sample string 1</d4p1:AccountName>
<d4p1:AccountNumber>sample string 3</d4p1:AccountNumber>
<d4p1:BankName>sample string 4</d4p1:BankName>
<d4p1:DateOpened>2025-01-18T23:53:12.3628527+00:00</d4p1:DateOpened>
<d4p1:SortCode>sample string 2</d4p1:SortCode>
</BankDetails>
<CurrentAddress>
<BuildingName>sample string 3</BuildingName>
<BuildingNumber>sample string 2</BuildingNumber>
<County>sample string 6</County>
<EndDate>2025-01-18T23:53:12.3618558+00:00</EndDate>
<Flat>sample string 1</Flat>
<Postcode>sample string 7</Postcode>
<StartDate>2025-01-18T23:53:12.3618558+00:00</StartDate>
<Status xmlns:d5p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
<Street>sample string 4</Street>
<Town>sample string 5</Town>
</CurrentAddress>
<DateOfBirth>2025-01-18T23:53:12.3618558+00:00</DateOfBirth>
<Email>sample string 4</Email>
<ForeName>sample string 1</ForeName>
<PreviousAddresses>
<Address>
<BuildingName>sample string 3</BuildingName>
<BuildingNumber>sample string 2</BuildingNumber>
<County>sample string 6</County>
<EndDate>2025-01-18T23:53:12.3618558+00:00</EndDate>
<Flat>sample string 1</Flat>
<Postcode>sample string 7</Postcode>
<StartDate>2025-01-18T23:53:12.3618558+00:00</StartDate>
<Status xmlns:d6p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
<Street>sample string 4</Street>
<Town>sample string 5</Town>
</Address>
<Address>
<BuildingName>sample string 3</BuildingName>
<BuildingNumber>sample string 2</BuildingNumber>
<County>sample string 6</County>
<EndDate>2025-01-18T23:53:12.3618558+00:00</EndDate>
<Flat>sample string 1</Flat>
<Postcode>sample string 7</Postcode>
<StartDate>2025-01-18T23:53:12.3618558+00:00</StartDate>
<Status xmlns:d6p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
<Street>sample string 4</Street>
<Town>sample string 5</Town>
</Address>
</PreviousAddresses>
<Surname>sample string 2</Surname>
</ApplicantModel>
<ApplicantModel>
<Id xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models">5</Id>
<BankDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/ERP.Domain.CRM.Applicant">
<d4p1:AccountName>sample string 1</d4p1:AccountName>
<d4p1:AccountNumber>sample string 3</d4p1:AccountNumber>
<d4p1:BankName>sample string 4</d4p1:BankName>
<d4p1:DateOpened>2025-01-18T23:53:12.3628527+00:00</d4p1:DateOpened>
<d4p1:SortCode>sample string 2</d4p1:SortCode>
</BankDetails>
<CurrentAddress>
<BuildingName>sample string 3</BuildingName>
<BuildingNumber>sample string 2</BuildingNumber>
<County>sample string 6</County>
<EndDate>2025-01-18T23:53:12.3618558+00:00</EndDate>
<Flat>sample string 1</Flat>
<Postcode>sample string 7</Postcode>
<StartDate>2025-01-18T23:53:12.3618558+00:00</StartDate>
<Status xmlns:d5p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
<Street>sample string 4</Street>
<Town>sample string 5</Town>
</CurrentAddress>
<DateOfBirth>2025-01-18T23:53:12.3618558+00:00</DateOfBirth>
<Email>sample string 4</Email>
<ForeName>sample string 1</ForeName>
<PreviousAddresses>
<Address>
<BuildingName>sample string 3</BuildingName>
<BuildingNumber>sample string 2</BuildingNumber>
<County>sample string 6</County>
<EndDate>2025-01-18T23:53:12.3618558+00:00</EndDate>
<Flat>sample string 1</Flat>
<Postcode>sample string 7</Postcode>
<StartDate>2025-01-18T23:53:12.3618558+00:00</StartDate>
<Status xmlns:d6p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
<Street>sample string 4</Street>
<Town>sample string 5</Town>
</Address>
<Address>
<BuildingName>sample string 3</BuildingName>
<BuildingNumber>sample string 2</BuildingNumber>
<County>sample string 6</County>
<EndDate>2025-01-18T23:53:12.3618558+00:00</EndDate>
<Flat>sample string 1</Flat>
<Postcode>sample string 7</Postcode>
<StartDate>2025-01-18T23:53:12.3618558+00:00</StartDate>
<Status xmlns:d6p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
<Street>sample string 4</Street>
<Town>sample string 5</Town>
</Address>
</PreviousAddresses>
<Surname>sample string 2</Surname>
</ApplicantModel>
</Applicants>
<TotalCount>1</TotalCount>
</ApplicantSearchModel>