POST v1/imports/onboarding-tasks?action={action}&allowSameFile={allowSameFile}

Import Division Onboarding Task Groups

Request Information

URI Parameters

Name	Description	Type	Additional information
action	The import action.	ImportAction	Default value is Insert
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 DivisionOnboardingTaskGroupImportDTO

Name	Type	Additional information
Tasks	Collection of OnboardingTaskSubImportDTO	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "tasks": [
      {
        "taskType": "PersonalInfo",
        "code": "sample string 1",
        "description": "sample string 2",
        "isRequired": true,
        "isActive": true,
        "externalPartner": null
      },
      {
        "taskType": "PersonalInfo",
        "code": "sample string 1",
        "description": "sample string 2",
        "isRequired": true,
        "isActive": true,
        "externalPartner": null
      }
    ],
    "divisionCode": "sample string 1",
    "companyCode": "sample string 2"
  },
  {
    "tasks": [
      {
        "taskType": "PersonalInfo",
        "code": "sample string 1",
        "description": "sample string 2",
        "isRequired": true,
        "isActive": true,
        "externalPartner": null
      },
      {
        "taskType": "PersonalInfo",
        "code": "sample string 1",
        "description": "sample string 2",
        "isRequired": true,
        "isActive": true,
        "externalPartner": null
      }
    ],
    "divisionCode": "sample string 1",
    "companyCode": "sample string 2"
  }
]

text/xml

Sample:

<ArrayOfDivisionOnboardingTaskGroupImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <DivisionOnboardingTaskGroupImportDTO>
    <CompanyCode>sample string 2</CompanyCode>
    <DivisionCode>sample string 1</DivisionCode>
    <Tasks>
      <OnboardingTaskSubImportDTO>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <ExternalPartner i:nil="true" />
        <IsActive>true</IsActive>
        <IsRequired>true</IsRequired>
        <TaskType>PersonalInfo</TaskType>
      </OnboardingTaskSubImportDTO>
      <OnboardingTaskSubImportDTO>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <ExternalPartner i:nil="true" />
        <IsActive>true</IsActive>
        <IsRequired>true</IsRequired>
        <TaskType>PersonalInfo</TaskType>
      </OnboardingTaskSubImportDTO>
    </Tasks>
  </DivisionOnboardingTaskGroupImportDTO>
  <DivisionOnboardingTaskGroupImportDTO>
    <CompanyCode>sample string 2</CompanyCode>
    <DivisionCode>sample string 1</DivisionCode>
    <Tasks>
      <OnboardingTaskSubImportDTO>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <ExternalPartner i:nil="true" />
        <IsActive>true</IsActive>
        <IsRequired>true</IsRequired>
        <TaskType>PersonalInfo</TaskType>
      </OnboardingTaskSubImportDTO>
      <OnboardingTaskSubImportDTO>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <ExternalPartner i:nil="true" />
        <IsActive>true</IsActive>
        <IsRequired>true</IsRequired>
        <TaskType>PersonalInfo</TaskType>
      </OnboardingTaskSubImportDTO>
    </Tasks>
  </DivisionOnboardingTaskGroupImportDTO>
</ArrayOfDivisionOnboardingTaskGroupImportDTO>

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>