POST crm/applicant

Method to submit new applicant

Request Information

URI Parameters

None.

Body Parameters

ERP.Api.Models.CRM.ApplicantModel

Name	Description	Type	Additional information
ForeName	Gets or sets the forename.	string	None.
Surname	Gets or sets the surname.	string	None.
DateOfBirth	Gets or sets the date of birth.	date	None.
Email	Gets or sets the email.	string	None.
CurrentAddress	Gets or sets the current address.	ERP.Api.Models.CRM.Address	None.
PreviousAddresses	Gets or sets the previous addresses.	Collection of ERP.Api.Models.CRM.Address	None.
BankDetails	Gets or sets the Bank details	ERP.Domain.CRM.Applicant.BankDetails	None.
Id		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "foreName": "sample string 1",
  "surname": "sample string 2",
  "dateOfBirth": "2025-01-19",
  "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-19",
    "endDate": "2025-01-19"
  },
  "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-19",
      "endDate": "2025-01-19"
    },
    {
      "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-19",
      "endDate": "2025-01-19"
    }
  ],
  "bankDetails": {
    "accountName": "sample string 1",
    "sortCode": "sample string 2",
    "accountNumber": "sample string 3",
    "dateOpened": "2025-01-19",
    "bankName": "sample string 4"
  },
  "id": 5
}

application/xml, text/xml

Sample:

<ApplicantModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models.CRM">
  <Id xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models">5</Id>
  <BankDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/ERP.Domain.CRM.Applicant">
    <d2p1:AccountName>sample string 1</d2p1:AccountName>
    <d2p1:AccountNumber>sample string 3</d2p1:AccountNumber>
    <d2p1:BankName>sample string 4</d2p1:BankName>
    <d2p1:DateOpened>2025-01-19T00:12:44.2329693+00:00</d2p1:DateOpened>
    <d2p1:SortCode>sample string 2</d2p1:SortCode>
  </BankDetails>
  <CurrentAddress>
    <BuildingName>sample string 3</BuildingName>
    <BuildingNumber>sample string 2</BuildingNumber>
    <County>sample string 6</County>
    <EndDate>2025-01-19T00:12:44.2329693+00:00</EndDate>
    <Flat>sample string 1</Flat>
    <Postcode>sample string 7</Postcode>
    <StartDate>2025-01-19T00:12:44.2329693+00:00</StartDate>
    <Status xmlns:d3p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
    <Street>sample string 4</Street>
    <Town>sample string 5</Town>
  </CurrentAddress>
  <DateOfBirth>2025-01-19T00:12:44.2329693+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-19T00:12:44.2329693+00:00</EndDate>
      <Flat>sample string 1</Flat>
      <Postcode>sample string 7</Postcode>
      <StartDate>2025-01-19T00:12:44.2329693+00:00</StartDate>
      <Status xmlns:d4p1="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-19T00:12:44.2329693+00:00</EndDate>
      <Flat>sample string 1</Flat>
      <Postcode>sample string 7</Postcode>
      <StartDate>2025-01-19T00:12:44.2329693+00:00</StartDate>
      <Status xmlns:d4p1="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>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'ERP.Api.Models.CRM.ApplicantModel'.

Response Information

Resource Description

Returns applicant data with ID

ERP.Api.Models.CRM.ApplicantModel

Name	Description	Type	Additional information
ForeName	Gets or sets the forename.	string	None.
Surname	Gets or sets the surname.	string	None.
DateOfBirth	Gets or sets the date of birth.	date	None.
Email	Gets or sets the email.	string	None.
CurrentAddress	Gets or sets the current address.	ERP.Api.Models.CRM.Address	None.
PreviousAddresses	Gets or sets the previous addresses.	Collection of ERP.Api.Models.CRM.Address	None.
BankDetails	Gets or sets the Bank details	ERP.Domain.CRM.Applicant.BankDetails	None.
Id		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "foreName": "sample string 1",
  "surname": "sample string 2",
  "dateOfBirth": "2025-01-19",
  "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-19",
    "endDate": "2025-01-19"
  },
  "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-19",
      "endDate": "2025-01-19"
    },
    {
      "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-19",
      "endDate": "2025-01-19"
    }
  ],
  "bankDetails": {
    "accountName": "sample string 1",
    "sortCode": "sample string 2",
    "accountNumber": "sample string 3",
    "dateOpened": "2025-01-19",
    "bankName": "sample string 4"
  },
  "id": 5
}

application/xml, text/xml

Sample:

<ApplicantModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models.CRM">
  <Id xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models">5</Id>
  <BankDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/ERP.Domain.CRM.Applicant">
    <d2p1:AccountName>sample string 1</d2p1:AccountName>
    <d2p1:AccountNumber>sample string 3</d2p1:AccountNumber>
    <d2p1:BankName>sample string 4</d2p1:BankName>
    <d2p1:DateOpened>2025-01-19T00:12:44.2329693+00:00</d2p1:DateOpened>
    <d2p1:SortCode>sample string 2</d2p1:SortCode>
  </BankDetails>
  <CurrentAddress>
    <BuildingName>sample string 3</BuildingName>
    <BuildingNumber>sample string 2</BuildingNumber>
    <County>sample string 6</County>
    <EndDate>2025-01-19T00:12:44.2329693+00:00</EndDate>
    <Flat>sample string 1</Flat>
    <Postcode>sample string 7</Postcode>
    <StartDate>2025-01-19T00:12:44.2329693+00:00</StartDate>
    <Status xmlns:d3p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
    <Street>sample string 4</Street>
    <Town>sample string 5</Town>
  </CurrentAddress>
  <DateOfBirth>2025-01-19T00:12:44.2329693+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-19T00:12:44.2329693+00:00</EndDate>
      <Flat>sample string 1</Flat>
      <Postcode>sample string 7</Postcode>
      <StartDate>2025-01-19T00:12:44.2329693+00:00</StartDate>
      <Status xmlns:d4p1="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-19T00:12:44.2329693+00:00</EndDate>
      <Flat>sample string 1</Flat>
      <Postcode>sample string 7</Postcode>
      <StartDate>2025-01-19T00:12:44.2329693+00:00</StartDate>
      <Status xmlns:d4p1="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>