POST dosconnect/UpdateApplicant

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
ApplicantID	integer	None.
Applicant	UpdateFirstApplicantModel	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "ApplicantID": 2,
  "Applicant": {
    "HomePhone": "sample string 1",
    "Dependents": "sample string 2",
    "LanguagePreferenceDD": 1,
    "ExistingClientFlag": true,
    "ClientNumber": "sample string 3",
    "FirstTimeBuyerFlag": true,
    "RelationShipDD": 1,
    "SalutationDD": 1,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "MiddleInitial": "sample string 6",
    "SuffixDD": 1,
    "DOB": "2025-04-11T06:51:45.8350408-04:00",
    "SIN": "sample string 7",
    "MaritalStatusDD": 1,
    "EmailAddress": "sample string 8",
    "PreferredContactMethodDD": 1,
    "WorkPhone": "sample string 9",
    "WorkPhoneExt": "sample string 10",
    "CellPhone": "sample string 11",
    "FAX": "sample string 12",
    "PrimaryFlag": true
  }
}

application/xml, text/xml

Sample:

<UpdateApplicantInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <APIKey>sample string 1</APIKey>
  <Applicant>
    <CellPhone>sample string 11</CellPhone>
    <DOB>2025-04-11T06:51:45.8350408-04:00</DOB>
    <EmailAddress>sample string 8</EmailAddress>
    <FAX>sample string 12</FAX>
    <FirstName>sample string 4</FirstName>
    <LastName>sample string 5</LastName>
    <MaritalStatusDD>1</MaritalStatusDD>
    <MiddleInitial>sample string 6</MiddleInitial>
    <PreferredContactMethodDD>1</PreferredContactMethodDD>
    <PrimaryFlag>true</PrimaryFlag>
    <SIN>sample string 7</SIN>
    <SalutationDD>1</SalutationDD>
    <SuffixDD>1</SuffixDD>
    <WorkPhone>sample string 9</WorkPhone>
    <WorkPhoneExt>sample string 10</WorkPhoneExt>
    <ClientNumber>sample string 3</ClientNumber>
    <Dependents>sample string 2</Dependents>
    <ExistingClientFlag>true</ExistingClientFlag>
    <FirstTimeBuyerFlag>true</FirstTimeBuyerFlag>
    <HomePhone>sample string 1</HomePhone>
    <LanguagePreferenceDD>1</LanguagePreferenceDD>
    <RelationShipDD>1</RelationShipDD>
  </Applicant>
  <ApplicantID>2</ApplicantID>
</UpdateApplicantInput>

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

Response Information

Resource Description

UpdateBaseOutput

Name	Description	Type	Additional information
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<UpdateBaseOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <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>
</UpdateBaseOutput>