DELETE v1/imports/licenses

Delete Licenses

Request Information

URI Parameters

None.

Body Parameters

The items to delete.

Name	Type	Additional information
LicenseKey	GlobalEntityKeyOfIEmployeeLicense	None.
EmployeeNumber	string	None.
EmployeePersonalId	integer	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "licenseKey": "<empty>",
    "employeeNumber": "sample string 1",
    "employeePersonalId": 1,
    "divisionCode": "sample string 2",
    "companyCode": "sample string 3"
  },
  {
    "licenseKey": "<empty>",
    "employeeNumber": "sample string 1",
    "employeePersonalId": 1,
    "divisionCode": "sample string 2",
    "companyCode": "sample string 3"
  }
]

text/xml

Sample:

<ArrayOfEmployeeLicenseHeaderDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <EmployeeLicenseHeaderDTO>
    <CompanyCode>sample string 3</CompanyCode>
    <DivisionCode>sample string 2</DivisionCode>
    <EmployeeNumber>sample string 1</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <LicenseKey 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>
    </LicenseKey>
  </EmployeeLicenseHeaderDTO>
  <EmployeeLicenseHeaderDTO>
    <CompanyCode>sample string 3</CompanyCode>
    <DivisionCode>sample string 2</DivisionCode>
    <EmployeeNumber>sample string 1</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <LicenseKey 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>
    </LicenseKey>
  </EmployeeLicenseHeaderDTO>
</ArrayOfEmployeeLicenseHeaderDTO>

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.