GET leads/{leadId}

Get lead by id

Request Information

URI Parameters

Name	Description	Type	Additional information
leadId		integer	Required

Body Parameters

None.

Response Information

Resource Description

GetLeadOutput

Name	Description	Type	Additional information
Lead		LeadDetailApiModel	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Lead": {
    "LeadId": 1,
    "Status": {
      "Value": 1,
      "Label": "sample string 1"
    },
    "Classification": {
      "Value": 1,
      "Label": "sample string 1"
    },
    "CreatedDate": "sample string 2",
    "UpdatedDate": "sample string 3",
    "LeadOwner": "sample string 4",
    "CreatedUser": "sample string 5",
    "ReferredBy": "sample string 6",
    "Note": "sample string 7",
    "LeadSources": [
      "sample string 1",
      "sample string 2"
    ],
    "LeadGroups": [
      "sample string 1",
      "sample string 2"
    ],
    "LeadTags": [
      "sample string 1",
      "sample string 2"
    ],
    "Applicants": [
      {
        "ApplicantId": 1,
        "FirstName": "sample string 2",
        "MiddleInitial": "sample string 3",
        "LastName": "sample string 4",
        "DateOfBirth": "sample string 5",
        "SIN": "sample string 6",
        "MartialStatus": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "CitizenshipType": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "LanguagePreference": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "ResidentialStatus": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "Relationship": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "CreditRange": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "IncomeRange": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "Address": {
          "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"
        },
        "ContactMethods": [
          {
            "Type": {
              "Value": 1,
              "Label": "sample string 1"
            },
            "Value": "sample string 1"
          },
          {
            "Type": {
              "Value": 1,
              "Label": "sample string 1"
            },
            "Value": "sample string 1"
          }
        ],
        "PrimaryFlag": true
      },
      {
        "ApplicantId": 1,
        "FirstName": "sample string 2",
        "MiddleInitial": "sample string 3",
        "LastName": "sample string 4",
        "DateOfBirth": "sample string 5",
        "SIN": "sample string 6",
        "MartialStatus": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "CitizenshipType": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "LanguagePreference": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "ResidentialStatus": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "Relationship": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "CreditRange": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "IncomeRange": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "Address": {
          "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"
        },
        "ContactMethods": [
          {
            "Type": {
              "Value": 1,
              "Label": "sample string 1"
            },
            "Value": "sample string 1"
          },
          {
            "Type": {
              "Value": 1,
              "Label": "sample string 1"
            },
            "Value": "sample string 1"
          }
        ],
        "PrimaryFlag": true
      }
    ],
    "MortgageInquiries": [
      {
        "DealId": 1,
        "MortgageRenewalDate": "sample string 2",
        "PurchasePrice": "sample string 3",
        "PropertyValue": "sample string 4",
        "DownPayment": "sample string 5",
        "RemainingMortgageAmount": "sample string 6",
        "AdditionalCash": "sample string 7",
        "PropertyUsage": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "PropertySearchStatus": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "LoanType": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "LoanPurpose": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "Timing": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "DwellingType": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "PropertyAddress": {
          "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"
        },
        "Applications": [
          {
            "ApplicationNumber": "sample string 1",
            "ApplicationId": 1
          },
          {
            "ApplicationNumber": "sample string 1",
            "ApplicationId": 1
          }
        ]
      },
      {
        "DealId": 1,
        "MortgageRenewalDate": "sample string 2",
        "PurchasePrice": "sample string 3",
        "PropertyValue": "sample string 4",
        "DownPayment": "sample string 5",
        "RemainingMortgageAmount": "sample string 6",
        "AdditionalCash": "sample string 7",
        "PropertyUsage": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "PropertySearchStatus": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "LoanType": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "LoanPurpose": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "Timing": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "DwellingType": {
          "Value": 1,
          "Label": "sample string 1"
        },
        "PropertyAddress": {
          "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"
        },
        "Applications": [
          {
            "ApplicationNumber": "sample string 1",
            "ApplicationId": 1
          },
          {
            "ApplicationNumber": "sample string 1",
            "ApplicationId": 1
          }
        ]
      }
    ]
  },
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<GetLeadOutput 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>
  <Lead>
    <Applicants>
      <LeadApiApplicantModel>
        <Address>
          <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>
        </Address>
        <ApplicantId>1</ApplicantId>
        <CitizenshipType>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </CitizenshipType>
        <ContactMethods>
          <ContactMethodModel>
            <Type>
              <Label>sample string 1</Label>
              <Value>1</Value>
            </Type>
            <Value>sample string 1</Value>
          </ContactMethodModel>
          <ContactMethodModel>
            <Type>
              <Label>sample string 1</Label>
              <Value>1</Value>
            </Type>
            <Value>sample string 1</Value>
          </ContactMethodModel>
        </ContactMethods>
        <CreditRange>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </CreditRange>
        <DateOfBirth>sample string 5</DateOfBirth>
        <FirstName>sample string 2</FirstName>
        <IncomeRange>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </IncomeRange>
        <LanguagePreference>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </LanguagePreference>
        <LastName>sample string 4</LastName>
        <MartialStatus>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </MartialStatus>
        <MiddleInitial>sample string 3</MiddleInitial>
        <PrimaryFlag>true</PrimaryFlag>
        <Relationship>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </Relationship>
        <ResidentialStatus>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </ResidentialStatus>
        <SIN>sample string 6</SIN>
      </LeadApiApplicantModel>
      <LeadApiApplicantModel>
        <Address>
          <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>
        </Address>
        <ApplicantId>1</ApplicantId>
        <CitizenshipType>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </CitizenshipType>
        <ContactMethods>
          <ContactMethodModel>
            <Type>
              <Label>sample string 1</Label>
              <Value>1</Value>
            </Type>
            <Value>sample string 1</Value>
          </ContactMethodModel>
          <ContactMethodModel>
            <Type>
              <Label>sample string 1</Label>
              <Value>1</Value>
            </Type>
            <Value>sample string 1</Value>
          </ContactMethodModel>
        </ContactMethods>
        <CreditRange>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </CreditRange>
        <DateOfBirth>sample string 5</DateOfBirth>
        <FirstName>sample string 2</FirstName>
        <IncomeRange>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </IncomeRange>
        <LanguagePreference>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </LanguagePreference>
        <LastName>sample string 4</LastName>
        <MartialStatus>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </MartialStatus>
        <MiddleInitial>sample string 3</MiddleInitial>
        <PrimaryFlag>true</PrimaryFlag>
        <Relationship>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </Relationship>
        <ResidentialStatus>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </ResidentialStatus>
        <SIN>sample string 6</SIN>
      </LeadApiApplicantModel>
    </Applicants>
    <Classification>
      <Label>sample string 1</Label>
      <Value>1</Value>
    </Classification>
    <CreatedDate>sample string 2</CreatedDate>
    <CreatedUser>sample string 5</CreatedUser>
    <LeadGroups xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </LeadGroups>
    <LeadId>1</LeadId>
    <LeadOwner>sample string 4</LeadOwner>
    <LeadSources xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </LeadSources>
    <LeadTags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </LeadTags>
    <MortgageInquiries>
      <LeadDealModel>
        <AdditionalCash>sample string 7</AdditionalCash>
        <Applications>
          <LeadMortgageApplicationModel>
            <ApplicationId>1</ApplicationId>
            <ApplicationNumber>sample string 1</ApplicationNumber>
          </LeadMortgageApplicationModel>
          <LeadMortgageApplicationModel>
            <ApplicationId>1</ApplicationId>
            <ApplicationNumber>sample string 1</ApplicationNumber>
          </LeadMortgageApplicationModel>
        </Applications>
        <DealId>1</DealId>
        <DownPayment>sample string 5</DownPayment>
        <DwellingType>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </DwellingType>
        <LoanPurpose>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </LoanPurpose>
        <LoanType>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </LoanType>
        <MortgageRenewalDate>sample string 2</MortgageRenewalDate>
        <PropertyAddress>
          <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>
        </PropertyAddress>
        <PropertySearchStatus>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </PropertySearchStatus>
        <PropertyUsage>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </PropertyUsage>
        <PropertyValue>sample string 4</PropertyValue>
        <PurchasePrice>sample string 3</PurchasePrice>
        <RemainingMortgageAmount>sample string 6</RemainingMortgageAmount>
        <Timing>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </Timing>
      </LeadDealModel>
      <LeadDealModel>
        <AdditionalCash>sample string 7</AdditionalCash>
        <Applications>
          <LeadMortgageApplicationModel>
            <ApplicationId>1</ApplicationId>
            <ApplicationNumber>sample string 1</ApplicationNumber>
          </LeadMortgageApplicationModel>
          <LeadMortgageApplicationModel>
            <ApplicationId>1</ApplicationId>
            <ApplicationNumber>sample string 1</ApplicationNumber>
          </LeadMortgageApplicationModel>
        </Applications>
        <DealId>1</DealId>
        <DownPayment>sample string 5</DownPayment>
        <DwellingType>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </DwellingType>
        <LoanPurpose>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </LoanPurpose>
        <LoanType>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </LoanType>
        <MortgageRenewalDate>sample string 2</MortgageRenewalDate>
        <PropertyAddress>
          <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>
        </PropertyAddress>
        <PropertySearchStatus>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </PropertySearchStatus>
        <PropertyUsage>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </PropertyUsage>
        <PropertyValue>sample string 4</PropertyValue>
        <PurchasePrice>sample string 3</PurchasePrice>
        <RemainingMortgageAmount>sample string 6</RemainingMortgageAmount>
        <Timing>
          <Label>sample string 1</Label>
          <Value>1</Value>
        </Timing>
      </LeadDealModel>
    </MortgageInquiries>
    <Note>sample string 7</Note>
    <ReferredBy>sample string 6</ReferredBy>
    <Status>
      <Label>sample string 1</Label>
      <Value>1</Value>
    </Status>
    <UpdatedDate>sample string 3</UpdatedDate>
  </Lead>
</GetLeadOutput>