POST v1/copy/division-setups?importAction={importAction}

Copy Division-Related Entities

Request Information

URI Parameters

NameDescriptionTypeAdditional information
importAction

The import action.

ImportAction

Default value is Override

Body Parameters

The items to copy.

Collection of CopyDivisionSetupDTO
NameDescriptionTypeAdditional information
CopyDivisionCostCenterLevels

boolean

None.

CopyDivisionCostCenterGroups

boolean

None.

CopyDivisionCheckTypes

boolean

None.

SourceCompanyCode

string

None.

SourceDivisionCode

string

None.

TargetCompanyCode

string

None.

TargetDivisionCode

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "copyDivisionCostCenterLevels": true,
    "copyDivisionCostCenterGroups": true,
    "copyDivisionCheckTypes": true,
    "sourceCompanyCode": "sample string 4",
    "sourceDivisionCode": "sample string 5",
    "targetCompanyCode": "sample string 6",
    "targetDivisionCode": "sample string 7"
  },
  {
    "copyDivisionCostCenterLevels": true,
    "copyDivisionCostCenterGroups": true,
    "copyDivisionCheckTypes": true,
    "sourceCompanyCode": "sample string 4",
    "sourceDivisionCode": "sample string 5",
    "targetCompanyCode": "sample string 6",
    "targetDivisionCode": "sample string 7"
  }
]

text/xml

Sample:
<ArrayOfCopyDivisionSetupDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <CopyDivisionSetupDTO>
    <SourceCompanyCode>sample string 4</SourceCompanyCode>
    <SourceDivisionCode>sample string 5</SourceDivisionCode>
    <TargetCompanyCode>sample string 6</TargetCompanyCode>
    <TargetDivisionCode>sample string 7</TargetDivisionCode>
    <CopyDivisionCheckTypes>true</CopyDivisionCheckTypes>
    <CopyDivisionCostCenterGroups>true</CopyDivisionCostCenterGroups>
    <CopyDivisionCostCenterLevels>true</CopyDivisionCostCenterLevels>
  </CopyDivisionSetupDTO>
  <CopyDivisionSetupDTO>
    <SourceCompanyCode>sample string 4</SourceCompanyCode>
    <SourceDivisionCode>sample string 5</SourceDivisionCode>
    <TargetCompanyCode>sample string 6</TargetCompanyCode>
    <TargetDivisionCode>sample string 7</TargetDivisionCode>
    <CopyDivisionCheckTypes>true</CopyDivisionCheckTypes>
    <CopyDivisionCostCenterGroups>true</CopyDivisionCostCenterGroups>
    <CopyDivisionCostCenterLevels>true</CopyDivisionCostCenterLevels>
  </CopyDivisionSetupDTO>
</ArrayOfCopyDivisionSetupDTO>

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

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>