POST api/Applicant

Post a new applicant

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PartnerId	integer	None.
PartnerName	string	None.
Key	string	None.
id	integer	None.
FirstName	string	None.
LastName	string	None.
Email	string	None.
Telephone	string	None.
Address1	string	None.
Address2	string	None.
Town	string	None.
County	integer	None.
PostCounty	string	None.
Postcode	string	None.
Country	string	None.
IP	string	None.
AgeRange	string	None.
SalaryRange	string	None.
Industry	string	None.
JobTitle	string	None.
CVFile	MultipartFileData	None.
Terms	boolean	None.
ThirdParty	boolean	None.
Refferals	Refferals	None.
Step	integer	None.
Interested	integer	None.
InterestedSale	integer	None.
Reason	integer	None.
Points	integer	None.
JustRegistered	boolean	None.
RegisteredDate	date	None.
LastRegisteredDate	date	None.
RegisteredCount	integer	None.
StepChangeDate	date	None.
CVAttached	boolean	None.
CVFileName	string	None.
CVFilePath	string	None.
CVThoughts	string	None.
SharedKey	string	None.
ValidationErrors	ValidationErrors	None.
Tags	string	None.
PurchasedProductIDs	string	None.
ApplicantQuotes	ApplicantQuotes	None.
RefferalInfo	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PartnerId": 1,
  "PartnerName": "sample string 1",
  "Key": "sample string 2",
  "id": 3,
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Email": "sample string 6",
  "Telephone": "sample string 7",
  "Address1": "sample string 8",
  "Address2": "sample string 9",
  "Town": "sample string 10",
  "County": 11,
  "PostCounty": "sample string 12",
  "Postcode": "sample string 13",
  "Country": "sample string 14",
  "IP": "sample string 15",
  "AgeRange": "sample string 16",
  "SalaryRange": "sample string 17",
  "Industry": "sample string 18",
  "JobTitle": "sample string 19",
  "CVFile": null,
  "Terms": true,
  "ThirdParty": true,
  "Refferals": {
    "Refferal": [
      {
        "Ref": "sample string 1",
        "Name": "sample string 2",
        "Settings": [
          {
            "Setting": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Setting": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      },
      {
        "Ref": "sample string 1",
        "Name": "sample string 2",
        "Settings": [
          {
            "Setting": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "Setting": [
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Name": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ]
      }
    ]
  },
  "Step": 22,
  "Interested": 23,
  "InterestedSale": 24,
  "Reason": 25,
  "Points": 26,
  "JustRegistered": true,
  "RegisteredDate": "2026-03-10T15:34:18.2431113+00:00",
  "LastRegisteredDate": "2026-03-10T15:34:18.2431113+00:00",
  "RegisteredCount": 30,
  "StepChangeDate": "2026-03-10T15:34:18.2431113+00:00",
  "CVAttached": true,
  "CVFileName": "sample string 33",
  "CVFilePath": "sample string 34",
  "CVThoughts": "sample string 35",
  "SharedKey": "sample string 36",
  "ValidationErrors": {
    "Errors": [
      {
        "Ref": "sample string 1",
        "Type": "sample string 2",
        "Description": "sample string 3"
      },
      {
        "Ref": "sample string 1",
        "Type": "sample string 2",
        "Description": "sample string 3"
      }
    ]
  },
  "Tags": "sample string 37",
  "PurchasedProductIDs": "sample string 38",
  "ApplicantQuotes": {
    "Quotes": [
      {
        "Date": "2026-03-10T15:34:18.2431113+00:00",
        "Product": "sample string 2",
        "ConsultantName": "sample string 3",
        "ConsultantId": 4,
        "Amount": "sample string 5"
      },
      {
        "Date": "2026-03-10T15:34:18.2431113+00:00",
        "Product": "sample string 2",
        "ConsultantName": "sample string 3",
        "ConsultantId": 4,
        "Amount": "sample string 5"
      }
    ]
  },
  "RefferalInfo": "sample string 39"
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'System.Net.Http.MultipartFileData' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'System.Net.Http.MultipartFileData' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Applicant'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.

POST api/Applicant

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

URI parameters

Headers | Add header

Body

Status

Headers

Body