POST v1/imports/employee-allocations?action={action}&allowSameFile={allowSameFile}

Import Employee Allocations

Request Information

URI Parameters

Name	Description	Type	Additional information
action	The import action.	ImportAction	Default value is Replace
allowSameFile	Determines if the import allows the content to be imported multiple times	boolean	Default value is True

Body Parameters

The items to import.

Collection of EmployeeAllocationDedicatedImportDTO

Name	Type	Additional information
IsPrimary	boolean	None.
AllocationPercent	decimal number	None.
JobCode	string	None.
CostCenter1Code	string	None.
CostCenter2Code	string	None.
CostCenter3Code	string	None.
CostCenter4Code	string	None.
CostCenter5Code	string	None.
EmployeeNumber	string	None.
EmployeePersonalId	integer	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "isPrimary": true,
    "allocationPercent": 2.0,
    "jobCode": "sample string 3",
    "costCenter1Code": "sample string 4",
    "costCenter2Code": "sample string 5",
    "costCenter3Code": "sample string 6",
    "costCenter4Code": "sample string 7",
    "costCenter5Code": "sample string 8",
    "employeeNumber": "sample string 9",
    "employeePersonalId": 1,
    "divisionCode": "sample string 10",
    "companyCode": "sample string 11"
  },
  {
    "isPrimary": true,
    "allocationPercent": 2.0,
    "jobCode": "sample string 3",
    "costCenter1Code": "sample string 4",
    "costCenter2Code": "sample string 5",
    "costCenter3Code": "sample string 6",
    "costCenter4Code": "sample string 7",
    "costCenter5Code": "sample string 8",
    "employeeNumber": "sample string 9",
    "employeePersonalId": 1,
    "divisionCode": "sample string 10",
    "companyCode": "sample string 11"
  }
]

text/xml

Sample:

<ArrayOfEmployeeAllocationDedicatedImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <EmployeeAllocationDedicatedImportDTO>
    <CompanyCode>sample string 11</CompanyCode>
    <DivisionCode>sample string 10</DivisionCode>
    <EmployeeNumber>sample string 9</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <AllocationPercent>2</AllocationPercent>
    <CostCenter1Code>sample string 4</CostCenter1Code>
    <CostCenter2Code>sample string 5</CostCenter2Code>
    <CostCenter3Code>sample string 6</CostCenter3Code>
    <CostCenter4Code>sample string 7</CostCenter4Code>
    <CostCenter5Code>sample string 8</CostCenter5Code>
    <IsPrimary>true</IsPrimary>
    <JobCode>sample string 3</JobCode>
  </EmployeeAllocationDedicatedImportDTO>
  <EmployeeAllocationDedicatedImportDTO>
    <CompanyCode>sample string 11</CompanyCode>
    <DivisionCode>sample string 10</DivisionCode>
    <EmployeeNumber>sample string 9</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <AllocationPercent>2</AllocationPercent>
    <CostCenter1Code>sample string 4</CostCenter1Code>
    <CostCenter2Code>sample string 5</CostCenter2Code>
    <CostCenter3Code>sample string 6</CostCenter3Code>
    <CostCenter4Code>sample string 7</CostCenter4Code>
    <CostCenter5Code>sample string 8</CostCenter5Code>
    <IsPrimary>true</IsPrimary>
    <JobCode>sample string 3</JobCode>
  </EmployeeAllocationDedicatedImportDTO>
</ArrayOfEmployeeAllocationDedicatedImportDTO>

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>