POST v1/imports/employee-dependents?importAction={importAction}&allowSameFile={allowSameFile}

Import Employee Dependents

Request Information

URI Parameters

Name	Description	Type	Additional information
importAction	The import action.	ImportAction	Default value is Override
allowSameFile	Determines if the import allows the content to be imported multiple times	boolean	Default value is True

Body Parameters

The items to import.

Collection of EmployeeDependentImportDTO

Name	Type	Additional information
DependentSSN	string	None.
FirstName	string	None.
LastName	string	None.
BirthDate	date	None.
MiddleInitial	string	None.
Gender	Gender	None.
DependentRelationship	DependentRelationship	None.
IsSmoker	boolean	None.
IsStudent	boolean	None.
IsDisabled	boolean	None.
Address	AddressDTO	None.
Phone	string	None.
EmployeeNumber	string	None.
EmployeePersonalId	integer	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "dependentSSN": "sample string 1",
    "firstName": "sample string 2",
    "lastName": "sample string 3",
    "birthDate": "0001-02-03",
    "middleInitial": "sample string 4",
    "gender": "Male",
    "dependentRelationship": "Other",
    "isSmoker": true,
    "isStudent": true,
    "isDisabled": true,
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zip": "sample string 5",
      "country": "sample string 6",
      "county": "sample string 7"
    },
    "phone": "sample string 5",
    "employeeNumber": "sample string 6",
    "employeePersonalId": 1,
    "divisionCode": "sample string 7",
    "companyCode": "sample string 8"
  },
  {
    "dependentSSN": "sample string 1",
    "firstName": "sample string 2",
    "lastName": "sample string 3",
    "birthDate": "0001-02-03",
    "middleInitial": "sample string 4",
    "gender": "Male",
    "dependentRelationship": "Other",
    "isSmoker": true,
    "isStudent": true,
    "isDisabled": true,
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zip": "sample string 5",
      "country": "sample string 6",
      "county": "sample string 7"
    },
    "phone": "sample string 5",
    "employeeNumber": "sample string 6",
    "employeePersonalId": 1,
    "divisionCode": "sample string 7",
    "companyCode": "sample string 8"
  }
]

text/xml

Sample:

<ArrayOfEmployeeDependentImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <EmployeeDependentImportDTO>
    <CompanyCode>sample string 8</CompanyCode>
    <DivisionCode>sample string 7</DivisionCode>
    <EmployeeNumber>sample string 6</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 7</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <BirthDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </BirthDate>
    <DependentRelationship>Other</DependentRelationship>
    <DependentSSN>sample string 1</DependentSSN>
    <FirstName>sample string 2</FirstName>
    <Gender>Male</Gender>
    <IsDisabled>true</IsDisabled>
    <IsSmoker>true</IsSmoker>
    <IsStudent>true</IsStudent>
    <LastName>sample string 3</LastName>
    <MiddleInitial>sample string 4</MiddleInitial>
    <Phone>sample string 5</Phone>
  </EmployeeDependentImportDTO>
  <EmployeeDependentImportDTO>
    <CompanyCode>sample string 8</CompanyCode>
    <DivisionCode>sample string 7</DivisionCode>
    <EmployeeNumber>sample string 6</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 7</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <BirthDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </BirthDate>
    <DependentRelationship>Other</DependentRelationship>
    <DependentSSN>sample string 1</DependentSSN>
    <FirstName>sample string 2</FirstName>
    <Gender>Male</Gender>
    <IsDisabled>true</IsDisabled>
    <IsSmoker>true</IsSmoker>
    <IsStudent>true</IsStudent>
    <LastName>sample string 3</LastName>
    <MiddleInitial>sample string 4</MiddleInitial>
    <Phone>sample string 5</Phone>
  </EmployeeDependentImportDTO>
</ArrayOfEmployeeDependentImportDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The results of the import.

ImportResultDTO

Name	Type	Additional information
NewRecords	integer	None.
UpdatedRecords	integer	None.
Errors	Collection of ImportErrorDTO	None.
NewRecordKeys	Collection of ImportKeyDTO	None.
UpdatedRecordKeys	Collection of ImportKeyDTO	None.
ImportKey	GlobalEntityKeyOfIImportSubmission	None.

Response Formats

application/json, text/json, text/xml

Sample:

Sample not available.