POST v1/imports/jobs?action={action}&allowSameFile={allowSameFile}

Import Division Jobs

Request Information

URI Parameters

NameDescriptionTypeAdditional 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 DivisionJobImportDTO
NameDescriptionTypeAdditional information
Code

string

Required

Description

string

None.

Rate

decimal number

None.

IsCertifiedJob

boolean

None.

Agency

string

None.

ContractNumber

string

None.

Address

AddressDTO

None.

WorkersCompCode

string

None.

RateCode

string

None.

ShiftCode

string

None.

HasProjectLaborAgreement

boolean

None.

AgencyPinNumber

string

None.

ContractorType

ContractorType

None.

NameOfPrimeContractor

string

None.

DivisionCode

string

None.

CompanyCode

string

Required

Request Formats

application/json, text/json

Sample:
[
  {
    "code": "sample string 1",
    "description": "sample string 2",
    "rate": 1.0,
    "isCertifiedJob": true,
    "agency": "sample string 3",
    "contractNumber": "sample string 4",
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zip": "sample string 5",
      "country": "sample string 6",
      "county": "sample string 7"
    },
    "workersCompCode": "sample string 5",
    "rateCode": "sample string 6",
    "shiftCode": "sample string 7",
    "hasProjectLaborAgreement": true,
    "agencyPinNumber": "sample string 8",
    "contractorType": "Contractor",
    "nameOfPrimeContractor": "sample string 9",
    "divisionCode": "sample string 10",
    "companyCode": "sample string 11"
  },
  {
    "code": "sample string 1",
    "description": "sample string 2",
    "rate": 1.0,
    "isCertifiedJob": true,
    "agency": "sample string 3",
    "contractNumber": "sample string 4",
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zip": "sample string 5",
      "country": "sample string 6",
      "county": "sample string 7"
    },
    "workersCompCode": "sample string 5",
    "rateCode": "sample string 6",
    "shiftCode": "sample string 7",
    "hasProjectLaborAgreement": true,
    "agencyPinNumber": "sample string 8",
    "contractorType": "Contractor",
    "nameOfPrimeContractor": "sample string 9",
    "divisionCode": "sample string 10",
    "companyCode": "sample string 11"
  }
]

text/xml

Sample:
<ArrayOfDivisionJobImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <DivisionJobImportDTO>
    <CompanyCode>sample string 11</CompanyCode>
    <DivisionCode>sample string 10</DivisionCode>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 7</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <Agency>sample string 3</Agency>
    <AgencyPinNumber>sample string 8</AgencyPinNumber>
    <Code>sample string 1</Code>
    <ContractNumber>sample string 4</ContractNumber>
    <ContractorType>Contractor</ContractorType>
    <Description>sample string 2</Description>
    <HasProjectLaborAgreement>true</HasProjectLaborAgreement>
    <IsCertifiedJob>true</IsCertifiedJob>
    <NameOfPrimeContractor>sample string 9</NameOfPrimeContractor>
    <Rate>1</Rate>
    <RateCode>sample string 6</RateCode>
    <ShiftCode>sample string 7</ShiftCode>
    <WorkersCompCode>sample string 5</WorkersCompCode>
  </DivisionJobImportDTO>
  <DivisionJobImportDTO>
    <CompanyCode>sample string 11</CompanyCode>
    <DivisionCode>sample string 10</DivisionCode>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 7</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <Agency>sample string 3</Agency>
    <AgencyPinNumber>sample string 8</AgencyPinNumber>
    <Code>sample string 1</Code>
    <ContractNumber>sample string 4</ContractNumber>
    <ContractorType>Contractor</ContractorType>
    <Description>sample string 2</Description>
    <HasProjectLaborAgreement>true</HasProjectLaborAgreement>
    <IsCertifiedJob>true</IsCertifiedJob>
    <NameOfPrimeContractor>sample string 9</NameOfPrimeContractor>
    <Rate>1</Rate>
    <RateCode>sample string 6</RateCode>
    <ShiftCode>sample string 7</ShiftCode>
    <WorkersCompCode>sample string 5</WorkersCompCode>
  </DivisionJobImportDTO>
</ArrayOfDivisionJobImportDTO>

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, text/xml

Sample:

Sample not available.