GET v1/export/clients/{clientCode}/employee-dependents

Retrieve Employee Dependents by Client

Request Information

URI Parameters

Name	Description	Type	Additional information
clientCode		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ExportEmployeeDependentDTO

Name	Type	Additional information
FirstName	string	None.
LastName	string	None.
MiddleInitial	string	None.
Address	AddressDTO	None.
Phone	string	None.
SSN	string	None.
BirthDate	date	None.
Gender	Gender	None.
RelationshipType	DependentRelationship	None.
IsSmoker	boolean	None.
IsStudent	boolean	None.
IsDisabled	boolean	None.
DivisionKey	DivisionKeyDTO	None.
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
EmployeeNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "firstName": "sample string 1",
    "lastName": "sample string 2",
    "middleInitial": "sample string 3",
    "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 4",
    "ssn": "sample string 5",
    "birthDate": "0001-02-03",
    "gender": "Male",
    "relationshipType": "Other",
    "isSmoker": true,
    "isStudent": true,
    "isDisabled": true,
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 9"
  },
  {
    "firstName": "sample string 1",
    "lastName": "sample string 2",
    "middleInitial": "sample string 3",
    "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 4",
    "ssn": "sample string 5",
    "birthDate": "0001-02-03",
    "gender": "Male",
    "relationshipType": "Other",
    "isSmoker": true,
    "isStudent": true,
    "isDisabled": true,
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 9"
  }
]

text/xml

Sample:

<ArrayOfExportEmployeeDependentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportEmployeeDependentDTO>
    <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:CompanyCode>sample string 1</d3p1:CompanyCode>
      <d3p1:DivisionCode>sample string 2</d3p1:DivisionCode>
    </DivisionKey>
    <EmployeeKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>false</d3p1:_hasValue>
        <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
      </d3p1:_entityKey>
    </EmployeeKey>
    <EmployeeNumber>sample string 9</EmployeeNumber>
    <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>
    <FirstName>sample string 1</FirstName>
    <Gender>Male</Gender>
    <IsDisabled>true</IsDisabled>
    <IsSmoker>true</IsSmoker>
    <IsStudent>true</IsStudent>
    <LastName>sample string 2</LastName>
    <MiddleInitial>sample string 3</MiddleInitial>
    <Phone>sample string 4</Phone>
    <RelationshipType>Other</RelationshipType>
    <SSN>sample string 5</SSN>
  </ExportEmployeeDependentDTO>
  <ExportEmployeeDependentDTO>
    <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:CompanyCode>sample string 1</d3p1:CompanyCode>
      <d3p1:DivisionCode>sample string 2</d3p1:DivisionCode>
    </DivisionKey>
    <EmployeeKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>false</d3p1:_hasValue>
        <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
      </d3p1:_entityKey>
    </EmployeeKey>
    <EmployeeNumber>sample string 9</EmployeeNumber>
    <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>
    <FirstName>sample string 1</FirstName>
    <Gender>Male</Gender>
    <IsDisabled>true</IsDisabled>
    <IsSmoker>true</IsSmoker>
    <IsStudent>true</IsStudent>
    <LastName>sample string 2</LastName>
    <MiddleInitial>sample string 3</MiddleInitial>
    <Phone>sample string 4</Phone>
    <RelationshipType>Other</RelationshipType>
    <SSN>sample string 5</SSN>
  </ExportEmployeeDependentDTO>
</ArrayOfExportEmployeeDependentDTO>