POST v1/Schedule/PostOpenShifts

Add open shifts from list of OpenShiftMetaData. Valid StartTime and EndTime are required.

Request Information

URI Parameters

None.

Body Parameters

Collection of OpenShiftMetaData
NameDescriptionTypeAdditional information
StartTime

Set start date and time for the schedule in MM/dd/yyyy HH:mm format e.g "01/01/2022 09:00".

string

Required

EndTime

Set end date and time for the schedule in MM/dd/yyyy HH:mm format e.g "01/01/2022 17:00".

string

Required

SchedulePolicy

Valid Schedule Policy Code or empty

string

None.

CostCenter1

Valid CostCenter1 Code or empty

string

None.

CostCenter2

Valid CostCenter2 Code or empty

string

None.

CostCenter3

Valid CostCenter3 Code or empty

string

None.

CostCenter4

Valid CostCenter4 Code or empty

string

None.

CostCenter5

Valid CostCenter5 Code or empty

string

None.

Job

Valid Job Code or empty

string

None.

Task

Valid Task Code or empty

string

None.

OverrideProfile

Valid Profile Code or empty

string

None.

ShiftCount

Shift count used to indicate number of open shifts being posted

integer

None.

Published

Posting the open shift as published or unpublished

boolean

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "StartTime": "sample string 1",
    "EndTime": "sample string 2",
    "SchedulePolicy": "sample string 3",
    "CostCenter1": "sample string 4",
    "CostCenter2": "sample string 5",
    "CostCenter3": "sample string 6",
    "CostCenter4": "sample string 7",
    "CostCenter5": "sample string 8",
    "Job": "sample string 9",
    "Task": "sample string 10",
    "OverrideProfile": "sample string 11",
    "ShiftCount": 1,
    "Published": true
  },
  {
    "StartTime": "sample string 1",
    "EndTime": "sample string 2",
    "SchedulePolicy": "sample string 3",
    "CostCenter1": "sample string 4",
    "CostCenter2": "sample string 5",
    "CostCenter3": "sample string 6",
    "CostCenter4": "sample string 7",
    "CostCenter5": "sample string 8",
    "Job": "sample string 9",
    "Task": "sample string 10",
    "OverrideProfile": "sample string 11",
    "ShiftCount": 1,
    "Published": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfOpenShiftMetaData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models">
  <OpenShiftMetaData>
    <CostCenter1>sample string 4</CostCenter1>
    <CostCenter2>sample string 5</CostCenter2>
    <CostCenter3>sample string 6</CostCenter3>
    <CostCenter4>sample string 7</CostCenter4>
    <CostCenter5>sample string 8</CostCenter5>
    <EndTime>sample string 2</EndTime>
    <Job>sample string 9</Job>
    <OverrideProfile>sample string 11</OverrideProfile>
    <Published>true</Published>
    <SchedulePolicy>sample string 3</SchedulePolicy>
    <ShiftCount>1</ShiftCount>
    <StartTime>sample string 1</StartTime>
    <Task>sample string 10</Task>
  </OpenShiftMetaData>
  <OpenShiftMetaData>
    <CostCenter1>sample string 4</CostCenter1>
    <CostCenter2>sample string 5</CostCenter2>
    <CostCenter3>sample string 6</CostCenter3>
    <CostCenter4>sample string 7</CostCenter4>
    <CostCenter5>sample string 8</CostCenter5>
    <EndTime>sample string 2</EndTime>
    <Job>sample string 9</Job>
    <OverrideProfile>sample string 11</OverrideProfile>
    <Published>true</Published>
    <SchedulePolicy>sample string 3</SchedulePolicy>
    <ShiftCount>1</ShiftCount>
    <StartTime>sample string 1</StartTime>
    <Task>sample string 10</Task>
  </OpenShiftMetaData>
</ArrayOfOpenShiftMetaData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.