DELETE v1/imports/check-history

Delete Historical Checks

Request Information

URI Parameters

None.

Body Parameters

The items to delete.

Collection of CheckHistoryDeleteDTO
NameDescriptionTypeAdditional information
CheckDate

date

None.

RunNumber

integer

None.

DivisionCode

string

None.

CompanyCode

string

Required

Request Formats

application/json, text/json

Sample:
[
  {
    "checkDate": "0001-02-03",
    "runNumber": 1,
    "divisionCode": "sample string 2",
    "companyCode": "sample string 3"
  },
  {
    "checkDate": "0001-02-03",
    "runNumber": 1,
    "divisionCode": "sample string 2",
    "companyCode": "sample string 3"
  }
]

text/xml

Sample:
<ArrayOfCheckHistoryDeleteDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <CheckHistoryDeleteDTO>
    <CompanyCode>sample string 3</CompanyCode>
    <DivisionCode>sample string 2</DivisionCode>
    <CheckDate 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>
    </CheckDate>
    <RunNumber>1</RunNumber>
  </CheckHistoryDeleteDTO>
  <CheckHistoryDeleteDTO>
    <CompanyCode>sample string 3</CompanyCode>
    <DivisionCode>sample string 2</DivisionCode>
    <CheckDate 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>
    </CheckDate>
    <RunNumber>1</RunNumber>
  </CheckHistoryDeleteDTO>
</ArrayOfCheckHistoryDeleteDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The results of the import.

ImportResultDTO
NameDescriptionTypeAdditional 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.