GET v1/export/companies/{companyCode}/divisions/{divisionCode}/employee-benefit-enrollments?employeeNumber={employeeNumber}

Retrieve Benefit Enrollments by Employee Number

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	The company code	string	Required
divisionCode	The division code	string	Required
employeeNumber	The employee number to filter the benefit enrollments by. If left blank, all benefit enrollments by Division will be returned.	string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ExportBenefitEnrollmentDTO

Name	Type	Additional information
EnrollmentStartDate	date	None.
EnrollmentEndDate	date	None.
PlanName	string	None.
BenefitEnrollmentType	BenefitEnrollmentType	None.
CoverageLevel	CoverageLevel	None.
Notes	string	None.
WaiveReason	string	None.
WaivePlanType	BenefitPlanType	None.
DivisionKey	DivisionKeyDTO	None.
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
EmployeeNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "enrollmentStartDate": "0001-02-03",
    "enrollmentEndDate": "0001-02-03",
    "planName": "sample string 1",
    "benefitEnrollmentType": "Enrollment",
    "coverageLevel": "EmployeeOnly",
    "notes": "sample string 2",
    "waiveReason": "sample string 3",
    "waivePlanType": "Other",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 4"
  },
  {
    "enrollmentStartDate": "0001-02-03",
    "enrollmentEndDate": "0001-02-03",
    "planName": "sample string 1",
    "benefitEnrollmentType": "Enrollment",
    "coverageLevel": "EmployeeOnly",
    "notes": "sample string 2",
    "waiveReason": "sample string 3",
    "waivePlanType": "Other",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 4"
  }
]

text/xml

Sample:

<ArrayOfExportBenefitEnrollmentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportBenefitEnrollmentDTO>
    <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 4</EmployeeNumber>
    <BenefitEnrollmentType>Enrollment</BenefitEnrollmentType>
    <CoverageLevel>EmployeeOnly</CoverageLevel>
    <EnrollmentEndDate 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>
    </EnrollmentEndDate>
    <EnrollmentStartDate 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>
    </EnrollmentStartDate>
    <Notes>sample string 2</Notes>
    <PlanName>sample string 1</PlanName>
    <WaivePlanType>Other</WaivePlanType>
    <WaiveReason>sample string 3</WaiveReason>
  </ExportBenefitEnrollmentDTO>
  <ExportBenefitEnrollmentDTO>
    <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 4</EmployeeNumber>
    <BenefitEnrollmentType>Enrollment</BenefitEnrollmentType>
    <CoverageLevel>EmployeeOnly</CoverageLevel>
    <EnrollmentEndDate 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>
    </EnrollmentEndDate>
    <EnrollmentStartDate 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>
    </EnrollmentStartDate>
    <Notes>sample string 2</Notes>
    <PlanName>sample string 1</PlanName>
    <WaivePlanType>Other</WaivePlanType>
    <WaiveReason>sample string 3</WaiveReason>
  </ExportBenefitEnrollmentDTO>
</ArrayOfExportBenefitEnrollmentDTO>