POST dosconnect/NewEmploymentHistory

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
ApplicantID	integer	None.
EmploymentHistory	UpdateEmploymentHistoryModel	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "ApplicantID": 2,
  "EmploymentHistory": {
    "EmployerName": "sample string 1",
    "EmploymentHistoryStatusDD": 1,
    "EmploymentHistoryTypeDD": 1,
    "IndustrySectorDD": 1,
    "JobTitle": "sample string 2",
    "MonthsOfService": 1,
    "OccupationDD": 1,
    "EmailAddress": "sample string 3",
    "OperatingAsDD": 1,
    "SelfEmployedFlag": true,
    "CompanyType": "sample string 4",
    "GrossRevenue": 1.0,
    "MonthsInInd": 1,
    "MonthsAtJob": 1,
    "Phone": "sample string 5",
    "PhoneExt": "sample string 6",
    "FAX": "sample string 7",
    "Address": {
      "AddressID": 1,
      "UnitNumber": "sample string 2",
      "StreetNumber": "sample string 3",
      "StreetName": "sample string 4",
      "StreetTypeDD": 1,
      "StreetDirectionDD": 1,
      "City": "sample string 5",
      "ProvinceDD": 1,
      "InternationalPostalCode": "sample string 6",
      "PostalFsa": "sample string 7",
      "PostalLdu": "sample string 8",
      "CountryTypeDD": 1
    },
    "Income": {
      "IncomeTypeDD": 1,
      "IncomePeriodDD": 1,
      "IncomeAmount": 1.0,
      "AnnualIncomeAmount": 2.0,
      "IncomeDescription": "sample string 3"
    }
  }
}

application/xml, text/xml

Sample:

<NewEmploymentHistoryInput 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>
  <ApplicantID>2</ApplicantID>
  <EmploymentHistory>
    <Address>
      <AddressID>1</AddressID>
      <City>sample string 5</City>
      <CountryTypeDD>1</CountryTypeDD>
      <InternationalPostalCode>sample string 6</InternationalPostalCode>
      <PostalFsa>sample string 7</PostalFsa>
      <PostalLdu>sample string 8</PostalLdu>
      <ProvinceDD>1</ProvinceDD>
      <StreetDirectionDD>1</StreetDirectionDD>
      <StreetName>sample string 4</StreetName>
      <StreetNumber>sample string 3</StreetNumber>
      <StreetTypeDD>1</StreetTypeDD>
      <UnitNumber>sample string 2</UnitNumber>
    </Address>
    <CompanyType>sample string 4</CompanyType>
    <EmailAddress>sample string 3</EmailAddress>
    <EmployerName>sample string 1</EmployerName>
    <EmploymentHistoryStatusDD>1</EmploymentHistoryStatusDD>
    <EmploymentHistoryTypeDD>1</EmploymentHistoryTypeDD>
    <FAX>sample string 7</FAX>
    <GrossRevenue>1</GrossRevenue>
    <Income>
      <AnnualIncomeAmount>2</AnnualIncomeAmount>
      <IncomeAmount>1</IncomeAmount>
      <IncomeDescription>sample string 3</IncomeDescription>
      <IncomePeriodDD>1</IncomePeriodDD>
      <IncomeTypeDD>1</IncomeTypeDD>
    </Income>
    <IndustrySectorDD>1</IndustrySectorDD>
    <JobTitle>sample string 2</JobTitle>
    <MonthsAtJob>1</MonthsAtJob>
    <MonthsInInd>1</MonthsInInd>
    <MonthsOfService>1</MonthsOfService>
    <OccupationDD>1</OccupationDD>
    <OperatingAsDD>1</OperatingAsDD>
    <Phone>sample string 5</Phone>
    <PhoneExt>sample string 6</PhoneExt>
    <SelfEmployedFlag>true</SelfEmployedFlag>
  </EmploymentHistory>
</NewEmploymentHistoryInput>

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

Response Information

Resource Description

NewEmploymentHistoryOutput

Name	Description	Type	Additional information
EmploymentHistoryID		integer	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<NewEmploymentHistoryOutput 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>
  <EmploymentHistoryID>1</EmploymentHistoryID>
</NewEmploymentHistoryOutput>