POST v1/imports/benefit-plans?action={action}&allowSameFile={allowSameFile}

Import Benefit Plans

Request Information

URI Parameters

Name	Description	Type	Additional information
action	The import action.	ImportAction	Default value is Insert
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 DivisionBenefitPlanImportDTO

Name	Type	Additional information
PlanName	string	None.
PlanDescription	string	None.
PlanType	string	None.
GroupNumber	string	None.
PlanNumber	string	None.
Notes	string	None.
BenefitPlanType	BenefitPlanType	None.
StartDate	date	None.
EndDate	date	None.
IsSelfInsured	boolean	None.
IsMinimumEssentialCoverage	boolean	None.
IsMinimumValueCoverage	boolean	None.
EmployeeCategoryFilterOption	EmployeeCategoryFilterOption	None.
ACAStatusFilter	ACAStatusFilter	None.
IsOffered	boolean	None.
BenefitPlanEmployeeCostType	BenefitPlanEmployeeCostType	None.
IsConditionalOffer	boolean	None.
CoverageLevels	Collection of DivisionBenefitPlanCoverageLevelSubImportDTO	None.
EligibilityRules	Collection of DivisionBenefitPlanEligibilityRuleSubImportDTO	None.
EmployeeCostDeductionCode	string	None.
EmployerCostDeductionCode	string	None.
IsICHRAPlan	boolean	None.
ICHRAAffordabilityOption	ICHRAAffordabilityOption	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "planName": "sample string 1",
    "planDescription": "sample string 2",
    "planType": "sample string 3",
    "groupNumber": "sample string 4",
    "planNumber": "sample string 5",
    "notes": "sample string 6",
    "benefitPlanType": "Other",
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "isSelfInsured": true,
    "isMinimumEssentialCoverage": true,
    "isMinimumValueCoverage": true,
    "employeeCategoryFilterOption": "All",
    "acaStatusFilter": "All",
    "isOffered": true,
    "benefitPlanEmployeeCostType": "Flat",
    "isConditionalOffer": true,
    "coverageLevels": [
      {
        "coverageLevel": "EmployeeOnly",
        "employeeCost": 1.0,
        "employerCost": 1.0
      },
      {
        "coverageLevel": "EmployeeOnly",
        "employeeCost": 1.0,
        "employerCost": 1.0
      }
    ],
    "eligibilityRules": [
      {
        "employeeCategoryCode": "sample string 1"
      },
      {
        "employeeCategoryCode": "sample string 1"
      }
    ],
    "employeeCostDeductionCode": "sample string 7",
    "employerCostDeductionCode": "sample string 8",
    "isICHRAPlan": true,
    "ichraAffordabilityOption": "NotAffordable",
    "divisionCode": "sample string 9",
    "companyCode": "sample string 10"
  },
  {
    "planName": "sample string 1",
    "planDescription": "sample string 2",
    "planType": "sample string 3",
    "groupNumber": "sample string 4",
    "planNumber": "sample string 5",
    "notes": "sample string 6",
    "benefitPlanType": "Other",
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "isSelfInsured": true,
    "isMinimumEssentialCoverage": true,
    "isMinimumValueCoverage": true,
    "employeeCategoryFilterOption": "All",
    "acaStatusFilter": "All",
    "isOffered": true,
    "benefitPlanEmployeeCostType": "Flat",
    "isConditionalOffer": true,
    "coverageLevels": [
      {
        "coverageLevel": "EmployeeOnly",
        "employeeCost": 1.0,
        "employerCost": 1.0
      },
      {
        "coverageLevel": "EmployeeOnly",
        "employeeCost": 1.0,
        "employerCost": 1.0
      }
    ],
    "eligibilityRules": [
      {
        "employeeCategoryCode": "sample string 1"
      },
      {
        "employeeCategoryCode": "sample string 1"
      }
    ],
    "employeeCostDeductionCode": "sample string 7",
    "employerCostDeductionCode": "sample string 8",
    "isICHRAPlan": true,
    "ichraAffordabilityOption": "NotAffordable",
    "divisionCode": "sample string 9",
    "companyCode": "sample string 10"
  }
]

text/xml

Sample:

<ArrayOfDivisionBenefitPlanImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <DivisionBenefitPlanImportDTO>
    <CompanyCode>sample string 10</CompanyCode>
    <DivisionCode>sample string 9</DivisionCode>
    <ACAStatusFilter>All</ACAStatusFilter>
    <BenefitPlanEmployeeCostType>Flat</BenefitPlanEmployeeCostType>
    <BenefitPlanType>Other</BenefitPlanType>
    <CoverageLevels>
      <DivisionBenefitPlanCoverageLevelSubImportDTO>
        <CoverageLevel>EmployeeOnly</CoverageLevel>
        <EmployeeCost>1</EmployeeCost>
        <EmployerCost>1</EmployerCost>
      </DivisionBenefitPlanCoverageLevelSubImportDTO>
      <DivisionBenefitPlanCoverageLevelSubImportDTO>
        <CoverageLevel>EmployeeOnly</CoverageLevel>
        <EmployeeCost>1</EmployeeCost>
        <EmployerCost>1</EmployerCost>
      </DivisionBenefitPlanCoverageLevelSubImportDTO>
    </CoverageLevels>
    <EligibilityRules>
      <DivisionBenefitPlanEligibilityRuleSubImportDTO>
        <EmployeeCategoryCode>sample string 1</EmployeeCategoryCode>
      </DivisionBenefitPlanEligibilityRuleSubImportDTO>
      <DivisionBenefitPlanEligibilityRuleSubImportDTO>
        <EmployeeCategoryCode>sample string 1</EmployeeCategoryCode>
      </DivisionBenefitPlanEligibilityRuleSubImportDTO>
    </EligibilityRules>
    <EmployeeCategoryFilterOption>All</EmployeeCategoryFilterOption>
    <EmployeeCostDeductionCode>sample string 7</EmployeeCostDeductionCode>
    <EmployerCostDeductionCode>sample string 8</EmployerCostDeductionCode>
    <EndDate 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>
    </EndDate>
    <GroupNumber>sample string 4</GroupNumber>
    <ICHRAAffordabilityOption>NotAffordable</ICHRAAffordabilityOption>
    <IsConditionalOffer>true</IsConditionalOffer>
    <IsICHRAPlan>true</IsICHRAPlan>
    <IsMinimumEssentialCoverage>true</IsMinimumEssentialCoverage>
    <IsMinimumValueCoverage>true</IsMinimumValueCoverage>
    <IsOffered>true</IsOffered>
    <IsSelfInsured>true</IsSelfInsured>
    <Notes>sample string 6</Notes>
    <PlanDescription>sample string 2</PlanDescription>
    <PlanName>sample string 1</PlanName>
    <PlanNumber>sample string 5</PlanNumber>
    <PlanType>sample string 3</PlanType>
    <StartDate 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>
    </StartDate>
  </DivisionBenefitPlanImportDTO>
  <DivisionBenefitPlanImportDTO>
    <CompanyCode>sample string 10</CompanyCode>
    <DivisionCode>sample string 9</DivisionCode>
    <ACAStatusFilter>All</ACAStatusFilter>
    <BenefitPlanEmployeeCostType>Flat</BenefitPlanEmployeeCostType>
    <BenefitPlanType>Other</BenefitPlanType>
    <CoverageLevels>
      <DivisionBenefitPlanCoverageLevelSubImportDTO>
        <CoverageLevel>EmployeeOnly</CoverageLevel>
        <EmployeeCost>1</EmployeeCost>
        <EmployerCost>1</EmployerCost>
      </DivisionBenefitPlanCoverageLevelSubImportDTO>
      <DivisionBenefitPlanCoverageLevelSubImportDTO>
        <CoverageLevel>EmployeeOnly</CoverageLevel>
        <EmployeeCost>1</EmployeeCost>
        <EmployerCost>1</EmployerCost>
      </DivisionBenefitPlanCoverageLevelSubImportDTO>
    </CoverageLevels>
    <EligibilityRules>
      <DivisionBenefitPlanEligibilityRuleSubImportDTO>
        <EmployeeCategoryCode>sample string 1</EmployeeCategoryCode>
      </DivisionBenefitPlanEligibilityRuleSubImportDTO>
      <DivisionBenefitPlanEligibilityRuleSubImportDTO>
        <EmployeeCategoryCode>sample string 1</EmployeeCategoryCode>
      </DivisionBenefitPlanEligibilityRuleSubImportDTO>
    </EligibilityRules>
    <EmployeeCategoryFilterOption>All</EmployeeCategoryFilterOption>
    <EmployeeCostDeductionCode>sample string 7</EmployeeCostDeductionCode>
    <EmployerCostDeductionCode>sample string 8</EmployerCostDeductionCode>
    <EndDate 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>
    </EndDate>
    <GroupNumber>sample string 4</GroupNumber>
    <ICHRAAffordabilityOption>NotAffordable</ICHRAAffordabilityOption>
    <IsConditionalOffer>true</IsConditionalOffer>
    <IsICHRAPlan>true</IsICHRAPlan>
    <IsMinimumEssentialCoverage>true</IsMinimumEssentialCoverage>
    <IsMinimumValueCoverage>true</IsMinimumValueCoverage>
    <IsOffered>true</IsOffered>
    <IsSelfInsured>true</IsSelfInsured>
    <Notes>sample string 6</Notes>
    <PlanDescription>sample string 2</PlanDescription>
    <PlanName>sample string 1</PlanName>
    <PlanNumber>sample string 5</PlanNumber>
    <PlanType>sample string 3</PlanType>
    <StartDate 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>
    </StartDate>
  </DivisionBenefitPlanImportDTO>
</ArrayOfDivisionBenefitPlanImportDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The result 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

Sample:

{
  "newRecords": 1,
  "updatedRecords": 2,
  "errors": [
    {
      "index": 1,
      "details": [
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    },
    {
      "index": 1,
      "details": [
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    }
  ],
  "newRecordKeys": [
    {
      "index": 1,
      "key": "sample string 2"
    },
    {
      "index": 1,
      "key": "sample string 2"
    }
  ],
  "updatedRecordKeys": [
    {
      "index": 1,
      "key": "sample string 2"
    },
    {
      "index": 1,
      "key": "sample string 2"
    }
  ],
  "importKey": "<empty>"
}

text/xml

Sample:

<ImportResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
  <Errors>
    <ImportErrorDTO>
      <Details>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
      </Details>
      <Index>1</Index>
    </ImportErrorDTO>
    <ImportErrorDTO>
      <Details>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
      </Details>
      <Index>1</Index>
    </ImportErrorDTO>
  </Errors>
  <ImportKey xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
    <d2p1:_entityKey>
      <d2p1:_hasValue>false</d2p1:_hasValue>
      <d2p1:_value>00000000-0000-0000-0000-000000000000</d2p1:_value>
    </d2p1:_entityKey>
  </ImportKey>
  <NewRecordKeys>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
  </NewRecordKeys>
  <NewRecords>1</NewRecords>
  <UpdatedRecordKeys>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
  </UpdatedRecordKeys>
  <UpdatedRecords>2</UpdatedRecords>
</ImportResultDTO>