DELETE v1/imports/employee-dependents
Delete Employee Dependents
Request Information
URI Parameters
None.
Body Parameters
The items to delete.
Collection of EmployeeDependentImportHeaderDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| DependentSSN | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| BirthDate | date |
None. |
|
| EmployeeNumber | string |
None. |
|
| EmployeePersonalId | integer |
None. |
|
| DivisionCode | string |
None. |
|
| CompanyCode | string |
Required |
Request Formats
application/json, text/json
Sample:
[
{
"dependentSSN": "sample string 1",
"firstName": "sample string 2",
"lastName": "sample string 3",
"birthDate": "0001-02-03",
"employeeNumber": "sample string 4",
"employeePersonalId": 1,
"divisionCode": "sample string 5",
"companyCode": "sample string 6"
},
{
"dependentSSN": "sample string 1",
"firstName": "sample string 2",
"lastName": "sample string 3",
"birthDate": "0001-02-03",
"employeeNumber": "sample string 4",
"employeePersonalId": 1,
"divisionCode": "sample string 5",
"companyCode": "sample string 6"
}
]
text/xml
Sample:
<ArrayOfEmployeeDependentImportHeaderDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
<EmployeeDependentImportHeaderDTO>
<CompanyCode>sample string 6</CompanyCode>
<DivisionCode>sample string 5</DivisionCode>
<EmployeeNumber>sample string 4</EmployeeNumber>
<EmployeePersonalId>1</EmployeePersonalId>
<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>
<DependentSSN>sample string 1</DependentSSN>
<FirstName>sample string 2</FirstName>
<LastName>sample string 3</LastName>
</EmployeeDependentImportHeaderDTO>
<EmployeeDependentImportHeaderDTO>
<CompanyCode>sample string 6</CompanyCode>
<DivisionCode>sample string 5</DivisionCode>
<EmployeeNumber>sample string 4</EmployeeNumber>
<EmployeePersonalId>1</EmployeePersonalId>
<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>
<DependentSSN>sample string 1</DependentSSN>
<FirstName>sample string 2</FirstName>
<LastName>sample string 3</LastName>
</EmployeeDependentImportHeaderDTO>
</ArrayOfEmployeeDependentImportHeaderDTO>
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.