DELETE v1/imports/employee-benefit-enrollments
Delete Benefit Enrollments
Request Information
URI Parameters
None.
Body Parameters
The items to delete.
Collection of EmployeeBenefitEnrollmentDeleteDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| EnrollmentStartDate | date |
None. |
|
| PlanName | string |
None. |
|
| RuleName | string |
None. |
|
| WaivePlanType | BenefitPlanType |
None. |
|
| EmployeeNumber | string |
None. |
|
| EmployeePersonalId | integer |
None. |
|
| DivisionCode | string |
None. |
|
| CompanyCode | string |
Required |
Request Formats
application/json, text/json
Sample:
[
{
"enrollmentStartDate": "0001-02-03",
"planName": "sample string 1",
"ruleName": "sample string 2",
"waivePlanType": "Other",
"employeeNumber": "sample string 3",
"employeePersonalId": 1,
"divisionCode": "sample string 4",
"companyCode": "sample string 5"
},
{
"enrollmentStartDate": "0001-02-03",
"planName": "sample string 1",
"ruleName": "sample string 2",
"waivePlanType": "Other",
"employeeNumber": "sample string 3",
"employeePersonalId": 1,
"divisionCode": "sample string 4",
"companyCode": "sample string 5"
}
]
text/xml
Sample:
<ArrayOfEmployeeBenefitEnrollmentDeleteDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
<EmployeeBenefitEnrollmentDeleteDTO>
<CompanyCode>sample string 5</CompanyCode>
<DivisionCode>sample string 4</DivisionCode>
<EmployeeNumber>sample string 3</EmployeeNumber>
<EmployeePersonalId>1</EmployeePersonalId>
<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>
<PlanName>sample string 1</PlanName>
<RuleName>sample string 2</RuleName>
<WaivePlanType>Other</WaivePlanType>
</EmployeeBenefitEnrollmentDeleteDTO>
<EmployeeBenefitEnrollmentDeleteDTO>
<CompanyCode>sample string 5</CompanyCode>
<DivisionCode>sample string 4</DivisionCode>
<EmployeeNumber>sample string 3</EmployeeNumber>
<EmployeePersonalId>1</EmployeePersonalId>
<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>
<PlanName>sample string 1</PlanName>
<RuleName>sample string 2</RuleName>
<WaivePlanType>Other</WaivePlanType>
</EmployeeBenefitEnrollmentDeleteDTO>
</ArrayOfEmployeeBenefitEnrollmentDeleteDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The results of the import.
ImportResultDTO| Name | Description | 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.