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

Import Benefit Enrollments

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 EmployeeBenefitEnrollmentImportDTO

Name	Type	Additional information
EnrollmentStartDate	date	None.
EnrollmentEndDate	date	None.
PlanName	string	None.
RuleName	string	None.
BenefitEnrollmentType	BenefitEnrollmentType	None.
WaivePlanType	BenefitPlanType	None.
CoverageLevel	CoverageLevel	None.
Notes	string	None.
WaiveReason	string	None.
WaiveBenefitReasonCode	string	None.
BenefitEnrollmentReasonCode	string	Required
BenefitEnrollmentReason	string	None.
BenefitEnrollmentSource	BenefitEnrollmentSource	None.
CoverageAmount	decimal number	None.
CoveredPayrollAmount	decimal number	None.
EmployeeContribution	decimal number	None.
EmployerDeduction	decimal number	None.
Documents	Collection of DivisionDocumentSubImportDTO	None.
EmployeeNumber	string	None.
EmployeePersonalId	integer	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "enrollmentStartDate": "0001-02-03",
    "enrollmentEndDate": "0001-02-03",
    "planName": "sample string 1",
    "ruleName": "sample string 2",
    "benefitEnrollmentType": "Enrollment",
    "waivePlanType": "Other",
    "coverageLevel": "EmployeeOnly",
    "notes": "sample string 3",
    "waiveReason": "sample string 4",
    "waiveBenefitReasonCode": "sample string 5",
    "benefitEnrollmentReasonCode": "sample string 6",
    "benefitEnrollmentReason": "sample string 7",
    "benefitEnrollmentSource": "AdminOverride",
    "coverageAmount": 1.0,
    "coveredPayrollAmount": 1.0,
    "employeeContribution": 1.0,
    "employerDeduction": 1.0,
    "documents": [
      {
        "content": "QEA=",
        "name": "sample string 1",
        "sourcePath": "sample string 2",
        "mimeType": "sample string 3",
        "documentTypeCode": "sample string 4"
      },
      {
        "content": "QEA=",
        "name": "sample string 1",
        "sourcePath": "sample string 2",
        "mimeType": "sample string 3",
        "documentTypeCode": "sample string 4"
      }
    ],
    "employeeNumber": "sample string 8",
    "employeePersonalId": 1,
    "divisionCode": "sample string 9",
    "companyCode": "sample string 10"
  },
  {
    "enrollmentStartDate": "0001-02-03",
    "enrollmentEndDate": "0001-02-03",
    "planName": "sample string 1",
    "ruleName": "sample string 2",
    "benefitEnrollmentType": "Enrollment",
    "waivePlanType": "Other",
    "coverageLevel": "EmployeeOnly",
    "notes": "sample string 3",
    "waiveReason": "sample string 4",
    "waiveBenefitReasonCode": "sample string 5",
    "benefitEnrollmentReasonCode": "sample string 6",
    "benefitEnrollmentReason": "sample string 7",
    "benefitEnrollmentSource": "AdminOverride",
    "coverageAmount": 1.0,
    "coveredPayrollAmount": 1.0,
    "employeeContribution": 1.0,
    "employerDeduction": 1.0,
    "documents": [
      {
        "content": "QEA=",
        "name": "sample string 1",
        "sourcePath": "sample string 2",
        "mimeType": "sample string 3",
        "documentTypeCode": "sample string 4"
      },
      {
        "content": "QEA=",
        "name": "sample string 1",
        "sourcePath": "sample string 2",
        "mimeType": "sample string 3",
        "documentTypeCode": "sample string 4"
      }
    ],
    "employeeNumber": "sample string 8",
    "employeePersonalId": 1,
    "divisionCode": "sample string 9",
    "companyCode": "sample string 10"
  }
]

text/xml

Sample:

<ArrayOfEmployeeBenefitEnrollmentImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <EmployeeBenefitEnrollmentImportDTO>
    <CompanyCode>sample string 10</CompanyCode>
    <DivisionCode>sample string 9</DivisionCode>
    <EmployeeNumber>sample string 8</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <BenefitEnrollmentReason>sample string 7</BenefitEnrollmentReason>
    <BenefitEnrollmentReasonCode>sample string 6</BenefitEnrollmentReasonCode>
    <BenefitEnrollmentSource>AdminOverride</BenefitEnrollmentSource>
    <BenefitEnrollmentType>Enrollment</BenefitEnrollmentType>
    <CoverageAmount>1</CoverageAmount>
    <CoverageLevel>EmployeeOnly</CoverageLevel>
    <CoveredPayrollAmount>1</CoveredPayrollAmount>
    <Documents>
      <DivisionDocumentSubImportDTO>
        <Content>QEA=</Content>
        <DocumentTypeCode>sample string 4</DocumentTypeCode>
        <MimeType>sample string 3</MimeType>
        <Name>sample string 1</Name>
        <SourcePath>sample string 2</SourcePath>
      </DivisionDocumentSubImportDTO>
      <DivisionDocumentSubImportDTO>
        <Content>QEA=</Content>
        <DocumentTypeCode>sample string 4</DocumentTypeCode>
        <MimeType>sample string 3</MimeType>
        <Name>sample string 1</Name>
        <SourcePath>sample string 2</SourcePath>
      </DivisionDocumentSubImportDTO>
    </Documents>
    <EmployeeContribution>1</EmployeeContribution>
    <EmployerDeduction>1</EmployerDeduction>
    <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 3</Notes>
    <PlanName>sample string 1</PlanName>
    <RuleName>sample string 2</RuleName>
    <WaiveBenefitReasonCode>sample string 5</WaiveBenefitReasonCode>
    <WaivePlanType>Other</WaivePlanType>
    <WaiveReason>sample string 4</WaiveReason>
  </EmployeeBenefitEnrollmentImportDTO>
  <EmployeeBenefitEnrollmentImportDTO>
    <CompanyCode>sample string 10</CompanyCode>
    <DivisionCode>sample string 9</DivisionCode>
    <EmployeeNumber>sample string 8</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <BenefitEnrollmentReason>sample string 7</BenefitEnrollmentReason>
    <BenefitEnrollmentReasonCode>sample string 6</BenefitEnrollmentReasonCode>
    <BenefitEnrollmentSource>AdminOverride</BenefitEnrollmentSource>
    <BenefitEnrollmentType>Enrollment</BenefitEnrollmentType>
    <CoverageAmount>1</CoverageAmount>
    <CoverageLevel>EmployeeOnly</CoverageLevel>
    <CoveredPayrollAmount>1</CoveredPayrollAmount>
    <Documents>
      <DivisionDocumentSubImportDTO>
        <Content>QEA=</Content>
        <DocumentTypeCode>sample string 4</DocumentTypeCode>
        <MimeType>sample string 3</MimeType>
        <Name>sample string 1</Name>
        <SourcePath>sample string 2</SourcePath>
      </DivisionDocumentSubImportDTO>
      <DivisionDocumentSubImportDTO>
        <Content>QEA=</Content>
        <DocumentTypeCode>sample string 4</DocumentTypeCode>
        <MimeType>sample string 3</MimeType>
        <Name>sample string 1</Name>
        <SourcePath>sample string 2</SourcePath>
      </DivisionDocumentSubImportDTO>
    </Documents>
    <EmployeeContribution>1</EmployeeContribution>
    <EmployerDeduction>1</EmployerDeduction>
    <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 3</Notes>
    <PlanName>sample string 1</PlanName>
    <RuleName>sample string 2</RuleName>
    <WaiveBenefitReasonCode>sample string 5</WaiveBenefitReasonCode>
    <WaivePlanType>Other</WaivePlanType>
    <WaiveReason>sample string 4</WaiveReason>
  </EmployeeBenefitEnrollmentImportDTO>
</ArrayOfEmployeeBenefitEnrollmentImportDTO>

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.