POST leads/applicants/add

Add applicant

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LeadId	integer	None.
RelationShipToPrimaryApplicant	integer	None.
FirstName	string	Required
LastName	string	Required
Email	string	None.
MobileNumber	string	None.
OtherGivenName	string	None.
DateOfBirth	string	None.
SIN	string	None.
MartialStatus	integer	None.
PreferredLanguage	integer	None.
ResidentialStatus	integer	None.
SelfEmployed	boolean	None.
WorkPhone	string	None.
CreditRating	integer	None.
IncomeRange	integer	None.
Citizenship	integer	None.
MailingAddress	LeadAddressModel	None.
CustomFields	Collection of APICustomFieldModel	None.

Request Formats

application/json, text/json

Sample:

{
  "LeadId": 1,
  "RelationShipToPrimaryApplicant": 1,
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Email": "sample string 4",
  "MobileNumber": "sample string 5",
  "OtherGivenName": "sample string 6",
  "DateOfBirth": "sample string 7",
  "SIN": "sample string 8",
  "MartialStatus": 1,
  "PreferredLanguage": 1,
  "ResidentialStatus": 1,
  "SelfEmployed": true,
  "WorkPhone": "sample string 9",
  "CreditRating": 1,
  "IncomeRange": 1,
  "Citizenship": 1,
  "MailingAddress": {
    "AddressId": 1,
    "Unit": "sample string 2",
    "StreetNumber": "sample string 3",
    "StreetName": "sample string 4",
    "StreetType": "sample string 5",
    "StreetDirection": "sample string 6",
    "City": "sample string 7",
    "Province": "sample string 8",
    "PostalCode": "sample string 9",
    "Country": "sample string 10"
  },
  "CustomFields": [
    {
      "FieldName": "sample string 1",
      "FieldValues": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "FieldName": "sample string 1",
      "FieldValues": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<AddApplicantModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.Lead">
  <Citizenship>1</Citizenship>
  <CreditRating>1</CreditRating>
  <CustomFields>
    <APICustomFieldModel>
      <FieldName>sample string 1</FieldName>
      <FieldValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </FieldValues>
    </APICustomFieldModel>
    <APICustomFieldModel>
      <FieldName>sample string 1</FieldName>
      <FieldValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </FieldValues>
    </APICustomFieldModel>
  </CustomFields>
  <DateOfBirth>sample string 7</DateOfBirth>
  <Email>sample string 4</Email>
  <FirstName>sample string 2</FirstName>
  <IncomeRange>1</IncomeRange>
  <LastName>sample string 3</LastName>
  <MailingAddress>
    <City>sample string 7</City>
    <Country>sample string 10</Country>
    <PostalCode>sample string 9</PostalCode>
    <Province>sample string 8</Province>
    <StreetDirection>sample string 6</StreetDirection>
    <StreetName>sample string 4</StreetName>
    <StreetNumber>sample string 3</StreetNumber>
    <StreetType>sample string 5</StreetType>
    <Unit>sample string 2</Unit>
    <AddressId>1</AddressId>
  </MailingAddress>
  <MartialStatus>1</MartialStatus>
  <MobileNumber>sample string 5</MobileNumber>
  <OtherGivenName>sample string 6</OtherGivenName>
  <PreferredLanguage>1</PreferredLanguage>
  <ResidentialStatus>1</ResidentialStatus>
  <SIN>sample string 8</SIN>
  <SelfEmployed>true</SelfEmployed>
  <WorkPhone>sample string 9</WorkPhone>
  <RelationShipToPrimaryApplicant>1</RelationShipToPrimaryApplicant>
  <LeadId>1</LeadId>
</AddApplicantModel>

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 'AddApplicantModel'.

Response Information

Resource Description

AddApplicantOutput

Name	Type	Additional information
LeadId	integer	None.
ApplicantId	integer	None.
ReturnStatus	ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "LeadId": 1,
  "ApplicantId": 2,
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<AddApplicantOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.Lead">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
  <ApplicantId>2</ApplicantId>
  <LeadId>1</LeadId>
</AddApplicantOutput>