POST v1/scheduling/import/companies/{companyCode}/divisions/{divisionCode}/shift-assignments?importAction={importAction}

Request Information

URI Parameters

Name	Type	Additional information
companyCode	string	Required
divisionCode	string	Required
importAction	ImportAction	Default value is Override

Body Parameters

Collection of ShiftAssignmentDTO

Name	Type	Additional information
ExternalReferenceId	string	None.
EmployeeNumber	string	None.
EmployeePersonalId	integer	None.
StartDateTime	date	None.
EndDateTime	date	None.
WorksiteCode	string	None.
StaffCategoryCode	string	None.
IsAbsent	boolean	None.
BreakMinutes	integer	None.
ShiftStatus	ShiftStatus	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "externalReferenceId": "sample string 1",
    "employeeNumber": "sample string 2",
    "employeePersonalId": 1,
    "startDateTime": "2026-09-13T21:33:03.2186957Z",
    "endDateTime": "2026-09-13T21:33:03.2186957Z",
    "worksiteCode": "sample string 3",
    "staffCategoryCode": "sample string 4",
    "isAbsent": true,
    "breakMinutes": 1,
    "shiftStatus": "Active"
  },
  {
    "externalReferenceId": "sample string 1",
    "employeeNumber": "sample string 2",
    "employeePersonalId": 1,
    "startDateTime": "2026-09-13T21:33:03.2186957Z",
    "endDateTime": "2026-09-13T21:33:03.2186957Z",
    "worksiteCode": "sample string 3",
    "staffCategoryCode": "sample string 4",
    "isAbsent": true,
    "breakMinutes": 1,
    "shiftStatus": "Active"
  }
]

text/xml

Sample:

<ArrayOfShiftAssignmentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ShiftAssignmentDTO>
    <BreakMinutes>1</BreakMinutes>
    <EmployeeNumber>sample string 2</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <EndDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-09-13T21:33:03.2186957Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </EndDateTime>
    <ExternalReferenceId>sample string 1</ExternalReferenceId>
    <IsAbsent>true</IsAbsent>
    <ShiftStatus>Active</ShiftStatus>
    <StaffCategoryCode>sample string 4</StaffCategoryCode>
    <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-09-13T21:33:03.2186957Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </StartDateTime>
    <WorksiteCode>sample string 3</WorksiteCode>
  </ShiftAssignmentDTO>
  <ShiftAssignmentDTO>
    <BreakMinutes>1</BreakMinutes>
    <EmployeeNumber>sample string 2</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <EndDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-09-13T21:33:03.2186957Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </EndDateTime>
    <ExternalReferenceId>sample string 1</ExternalReferenceId>
    <IsAbsent>true</IsAbsent>
    <ShiftStatus>Active</ShiftStatus>
    <StaffCategoryCode>sample string 4</StaffCategoryCode>
    <StartDateTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-09-13T21:33:03.2186957Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </StartDateTime>
    <WorksiteCode>sample string 3</WorksiteCode>
  </ShiftAssignmentDTO>
</ArrayOfShiftAssignmentDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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>