POST v1/copy/employees?importAction={importAction}

Copy Employees

Request Information

URI Parameters

Name	Description	Type	Additional information
importAction	The import action.	ImportAction	Default value is Override

Body Parameters

The items to copy.

Collection of CopyEmployeeDTO

Name	Type	Additional information
FilterEmployeeNumber	string	None.
FilterCostCenter1	string	None.
FilterCostCenter2	string	None.
FilterCostCenter3	string	None.
FilterCostCenter4	string	None.
FilterCostCenter5	string	None.
FilterJobCode	string	None.
FilterEmployeeStatus	EmployeeStatus	None.
SharePersonal	boolean	None.
CopyPersonal	boolean	None.
CopyEducation	boolean	None.
CopyPreviousEmployers	boolean	None.
CopyTrainings	boolean	None.
CopySkills	boolean	None.
CopyEmployee	boolean	None.
CopyEligibility	boolean	None.
CopyEEO	boolean	None.
CopyPayRates	boolean	None.
CopyTaxes	boolean	None.
CopyEmployeeCategory	boolean	None.
CopyDirectDeposits	boolean	None.
CopyScheduledDeductions	boolean	None.
CopyScheduledEarnings	boolean	None.
CopyAllocations	boolean	None.
CopyEmergencyContacts	boolean	None.
CopyLicenses	boolean	None.
CopyPTOAccruals	boolean	None.
CopyDependents	boolean	None.
CopyBenefitEnrollments	boolean	None.
CopyCustomFields	boolean	None.
CopyReviews	boolean	None.
CopyOtherAttachments	boolean	None.
CopyEmployeeSchedules	boolean	None.
CopyNotes	boolean	None.
CopyAssets	boolean	None.
CopyEvents	boolean	None.
GenerateNewEmployeeNumbers	boolean	None.
MappingOverrides	Collection of CopyEmployeeMappingDTO	None.
SourceCompanyCode	string	None.
SourceDivisionCode	string	None.
TargetCompanyCode	string	None.
TargetDivisionCode	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "filterEmployeeNumber": "sample string 1",
    "filterCostCenter1": "sample string 2",
    "filterCostCenter2": "sample string 3",
    "filterCostCenter3": "sample string 4",
    "filterCostCenter4": "sample string 5",
    "filterCostCenter5": "sample string 6",
    "filterJobCode": "sample string 7",
    "filterEmployeeStatus": "Active",
    "sharePersonal": true,
    "copyPersonal": true,
    "copyEducation": true,
    "copyPreviousEmployers": true,
    "copyTrainings": true,
    "copySkills": true,
    "copyEmployee": true,
    "copyEligibility": true,
    "copyEEO": true,
    "copyPayRates": true,
    "copyTaxes": true,
    "copyEmployeeCategory": true,
    "copyDirectDeposits": true,
    "copyScheduledDeductions": true,
    "copyScheduledEarnings": true,
    "copyAllocations": true,
    "copyEmergencyContacts": true,
    "copyLicenses": true,
    "copyPTOAccruals": true,
    "copyDependents": true,
    "copyBenefitEnrollments": true,
    "copyCustomFields": true,
    "copyReviews": true,
    "copyOtherAttachments": true,
    "copyEmployeeSchedules": true,
    "copyNotes": true,
    "copyAssets": true,
    "copyEvents": true,
    "generateNewEmployeeNumbers": true,
    "mappingOverrides": [
      {
        "fieldName": "sample string 1",
        "sourceCode": "sample string 2",
        "targetCode": "sample string 3"
      },
      {
        "fieldName": "sample string 1",
        "sourceCode": "sample string 2",
        "targetCode": "sample string 3"
      }
    ],
    "sourceCompanyCode": "sample string 37",
    "sourceDivisionCode": "sample string 38",
    "targetCompanyCode": "sample string 39",
    "targetDivisionCode": "sample string 40"
  },
  {
    "filterEmployeeNumber": "sample string 1",
    "filterCostCenter1": "sample string 2",
    "filterCostCenter2": "sample string 3",
    "filterCostCenter3": "sample string 4",
    "filterCostCenter4": "sample string 5",
    "filterCostCenter5": "sample string 6",
    "filterJobCode": "sample string 7",
    "filterEmployeeStatus": "Active",
    "sharePersonal": true,
    "copyPersonal": true,
    "copyEducation": true,
    "copyPreviousEmployers": true,
    "copyTrainings": true,
    "copySkills": true,
    "copyEmployee": true,
    "copyEligibility": true,
    "copyEEO": true,
    "copyPayRates": true,
    "copyTaxes": true,
    "copyEmployeeCategory": true,
    "copyDirectDeposits": true,
    "copyScheduledDeductions": true,
    "copyScheduledEarnings": true,
    "copyAllocations": true,
    "copyEmergencyContacts": true,
    "copyLicenses": true,
    "copyPTOAccruals": true,
    "copyDependents": true,
    "copyBenefitEnrollments": true,
    "copyCustomFields": true,
    "copyReviews": true,
    "copyOtherAttachments": true,
    "copyEmployeeSchedules": true,
    "copyNotes": true,
    "copyAssets": true,
    "copyEvents": true,
    "generateNewEmployeeNumbers": true,
    "mappingOverrides": [
      {
        "fieldName": "sample string 1",
        "sourceCode": "sample string 2",
        "targetCode": "sample string 3"
      },
      {
        "fieldName": "sample string 1",
        "sourceCode": "sample string 2",
        "targetCode": "sample string 3"
      }
    ],
    "sourceCompanyCode": "sample string 37",
    "sourceDivisionCode": "sample string 38",
    "targetCompanyCode": "sample string 39",
    "targetDivisionCode": "sample string 40"
  }
]

text/xml

Sample:

<ArrayOfCopyEmployeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <CopyEmployeeDTO>
    <SourceCompanyCode>sample string 37</SourceCompanyCode>
    <SourceDivisionCode>sample string 38</SourceDivisionCode>
    <TargetCompanyCode>sample string 39</TargetCompanyCode>
    <TargetDivisionCode>sample string 40</TargetDivisionCode>
    <CopyAllocations>true</CopyAllocations>
    <CopyAssets>true</CopyAssets>
    <CopyBenefitEnrollments>true</CopyBenefitEnrollments>
    <CopyCustomFields>true</CopyCustomFields>
    <CopyDependents>true</CopyDependents>
    <CopyDirectDeposits>true</CopyDirectDeposits>
    <CopyEEO>true</CopyEEO>
    <CopyEducation>true</CopyEducation>
    <CopyEligibility>true</CopyEligibility>
    <CopyEmergencyContacts>true</CopyEmergencyContacts>
    <CopyEmployee>true</CopyEmployee>
    <CopyEmployeeCategory>true</CopyEmployeeCategory>
    <CopyEmployeeSchedules>true</CopyEmployeeSchedules>
    <CopyEvents>true</CopyEvents>
    <CopyLicenses>true</CopyLicenses>
    <CopyNotes>true</CopyNotes>
    <CopyOtherAttachments>true</CopyOtherAttachments>
    <CopyPTOAccruals>true</CopyPTOAccruals>
    <CopyPayRates>true</CopyPayRates>
    <CopyPersonal>true</CopyPersonal>
    <CopyPreviousEmployers>true</CopyPreviousEmployers>
    <CopyReviews>true</CopyReviews>
    <CopyScheduledDeductions>true</CopyScheduledDeductions>
    <CopyScheduledEarnings>true</CopyScheduledEarnings>
    <CopySkills>true</CopySkills>
    <CopyTaxes>true</CopyTaxes>
    <CopyTrainings>true</CopyTrainings>
    <FilterCostCenter1>sample string 2</FilterCostCenter1>
    <FilterCostCenter2>sample string 3</FilterCostCenter2>
    <FilterCostCenter3>sample string 4</FilterCostCenter3>
    <FilterCostCenter4>sample string 5</FilterCostCenter4>
    <FilterCostCenter5>sample string 6</FilterCostCenter5>
    <FilterEmployeeNumber>sample string 1</FilterEmployeeNumber>
    <FilterEmployeeStatus>Active</FilterEmployeeStatus>
    <FilterJobCode>sample string 7</FilterJobCode>
    <GenerateNewEmployeeNumbers>true</GenerateNewEmployeeNumbers>
    <MappingOverrides>
      <CopyEmployeeMappingDTO>
        <FieldName>sample string 1</FieldName>
        <SourceCode>sample string 2</SourceCode>
        <TargetCode>sample string 3</TargetCode>
      </CopyEmployeeMappingDTO>
      <CopyEmployeeMappingDTO>
        <FieldName>sample string 1</FieldName>
        <SourceCode>sample string 2</SourceCode>
        <TargetCode>sample string 3</TargetCode>
      </CopyEmployeeMappingDTO>
    </MappingOverrides>
    <SharePersonal>true</SharePersonal>
  </CopyEmployeeDTO>
  <CopyEmployeeDTO>
    <SourceCompanyCode>sample string 37</SourceCompanyCode>
    <SourceDivisionCode>sample string 38</SourceDivisionCode>
    <TargetCompanyCode>sample string 39</TargetCompanyCode>
    <TargetDivisionCode>sample string 40</TargetDivisionCode>
    <CopyAllocations>true</CopyAllocations>
    <CopyAssets>true</CopyAssets>
    <CopyBenefitEnrollments>true</CopyBenefitEnrollments>
    <CopyCustomFields>true</CopyCustomFields>
    <CopyDependents>true</CopyDependents>
    <CopyDirectDeposits>true</CopyDirectDeposits>
    <CopyEEO>true</CopyEEO>
    <CopyEducation>true</CopyEducation>
    <CopyEligibility>true</CopyEligibility>
    <CopyEmergencyContacts>true</CopyEmergencyContacts>
    <CopyEmployee>true</CopyEmployee>
    <CopyEmployeeCategory>true</CopyEmployeeCategory>
    <CopyEmployeeSchedules>true</CopyEmployeeSchedules>
    <CopyEvents>true</CopyEvents>
    <CopyLicenses>true</CopyLicenses>
    <CopyNotes>true</CopyNotes>
    <CopyOtherAttachments>true</CopyOtherAttachments>
    <CopyPTOAccruals>true</CopyPTOAccruals>
    <CopyPayRates>true</CopyPayRates>
    <CopyPersonal>true</CopyPersonal>
    <CopyPreviousEmployers>true</CopyPreviousEmployers>
    <CopyReviews>true</CopyReviews>
    <CopyScheduledDeductions>true</CopyScheduledDeductions>
    <CopyScheduledEarnings>true</CopyScheduledEarnings>
    <CopySkills>true</CopySkills>
    <CopyTaxes>true</CopyTaxes>
    <CopyTrainings>true</CopyTrainings>
    <FilterCostCenter1>sample string 2</FilterCostCenter1>
    <FilterCostCenter2>sample string 3</FilterCostCenter2>
    <FilterCostCenter3>sample string 4</FilterCostCenter3>
    <FilterCostCenter4>sample string 5</FilterCostCenter4>
    <FilterCostCenter5>sample string 6</FilterCostCenter5>
    <FilterEmployeeNumber>sample string 1</FilterEmployeeNumber>
    <FilterEmployeeStatus>Active</FilterEmployeeStatus>
    <FilterJobCode>sample string 7</FilterJobCode>
    <GenerateNewEmployeeNumbers>true</GenerateNewEmployeeNumbers>
    <MappingOverrides>
      <CopyEmployeeMappingDTO>
        <FieldName>sample string 1</FieldName>
        <SourceCode>sample string 2</SourceCode>
        <TargetCode>sample string 3</TargetCode>
      </CopyEmployeeMappingDTO>
      <CopyEmployeeMappingDTO>
        <FieldName>sample string 1</FieldName>
        <SourceCode>sample string 2</SourceCode>
        <TargetCode>sample string 3</TargetCode>
      </CopyEmployeeMappingDTO>
    </MappingOverrides>
    <SharePersonal>true</SharePersonal>
  </CopyEmployeeDTO>
</ArrayOfCopyEmployeeDTO>

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

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>