GET v1/divisions/{divisionId}/imports/{serviceCode}

Retrieve Division Import Details

Request Information

URI Parameters

Name	Description	Type	Additional information
divisionId	The Division ID of the division of the import.	string	Required
serviceCode	The type of import.	ImportServiceCode	Required

Body Parameters

None.

Response Information

Resource Description

ImportMetadataDTO

Name	Type	Additional information
Options	ImportOptionsMetadataDTO	None.
Code	string	None.
Description	string	None.

Response Formats

application/json, text/json

Sample:

{
  "options": {
    "actions": [
      "Update",
      "Update"
    ],
    "behaviors": [
      "AllowPartialImport",
      "AllowPartialImport"
    ],
    "templates": [
      {
        "code": "sample string 1",
        "description": "sample string 2",
        "hasHeaderRecord": true,
        "defaultAction": "Update",
        "defaultBehavior": "None"
      },
      {
        "code": "sample string 1",
        "description": "sample string 2",
        "hasHeaderRecord": true,
        "defaultAction": "Update",
        "defaultBehavior": "None"
      }
    ],
    "defaultBatchSize": 1
  },
  "code": "sample string 1",
  "description": "sample string 2"
}

text/xml

Sample:

<ImportMetadataDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <Code>sample string 1</Code>
  <Description>sample string 2</Description>
  <Options>
    <Actions xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Enums">
      <d3p1:ImportAction>Update</d3p1:ImportAction>
      <d3p1:ImportAction>Update</d3p1:ImportAction>
    </Actions>
    <Behaviors xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Enums">
      <d3p1:ImportBehavior>AllowPartialImport</d3p1:ImportBehavior>
      <d3p1:ImportBehavior>AllowPartialImport</d3p1:ImportBehavior>
    </Behaviors>
    <DefaultBatchSize>1</DefaultBatchSize>
    <Templates>
      <ImportTemplate>
        <Code>sample string 1</Code>
        <DefaultAction>Update</DefaultAction>
        <DefaultBehavior>None</DefaultBehavior>
        <Description>sample string 2</Description>
        <HasHeaderRecord>true</HasHeaderRecord>
      </ImportTemplate>
      <ImportTemplate>
        <Code>sample string 1</Code>
        <DefaultAction>Update</DefaultAction>
        <DefaultBehavior>None</DefaultBehavior>
        <Description>sample string 2</Description>
        <HasHeaderRecord>true</HasHeaderRecord>
      </ImportTemplate>
    </Templates>
  </Options>
</ImportMetadataDTO>