GET v1/Reports/GetSchedulesByDate?startDate={startDate}&endDate={endDate}
Returns All Schedules for a Specified Date Range
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
startDate |
The Range Start Date. e.g 2014-01-01 |
date |
Required |
endDate |
The Range End Date. e.g 2014-01-01 |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ScheduleMetaDataName | Description | Type | Additional information |
---|---|---|---|
EmployeeNumber |
Gets or sets the employee number. |
string |
None. |
StartDate |
Gets or sets start date for the schedule in MM/dd/yyyy format e.g 01/01/2022. |
string |
None. |
StartTime |
Gets or sets start time for the schedule in HH:mm y format e.g 09:00. |
string |
None. |
EndDate |
Gets or sets end date for the schedule in MM/dd/yyyy format e.g 01/01/2022. |
string |
None. |
EndTime |
Gets or sets end time for the schedule in HH:mm y format e.g 17:00. |
string |
None. |
SchedulePolicy |
Gets or sets code to use for the schedule policy. |
string |
None. |
CostCenter1 | string |
None. |
|
CostCenter2 | string |
None. |
|
CostCenter3 | string |
None. |
|
CostCenter4 | string |
None. |
|
CostCenter5 | string |
None. |
|
Job |
Valid Job Code |
string |
None. |
Task |
Valid Task Code |
string |
None. |
OverrideProfile |
Valid Profile Code |
string |
None. |
TimeClockScheduleID |
Unique ID tied to the schedule used for deleting |
integer |
None. |
ShiftNumber |
Shift Number used to indicate sequence when adding multiple schedules on same day for one employee |
integer |
None. |
Response Formats
application/json, text/json
[ { "EmployeeNumber": "sample string 1", "StartDate": "sample string 2", "StartTime": "sample string 3", "EndDate": "sample string 4", "EndTime": "sample string 5", "SchedulePolicy": "sample string 6", "CostCenter1": "sample string 7", "CostCenter2": "sample string 8", "CostCenter3": "sample string 9", "CostCenter4": "sample string 10", "CostCenter5": "sample string 11", "Job": "sample string 12", "Task": "sample string 13", "OverrideProfile": "sample string 14", "TimeClockScheduleID": 15, "ShiftNumber": 16 }, { "EmployeeNumber": "sample string 1", "StartDate": "sample string 2", "StartTime": "sample string 3", "EndDate": "sample string 4", "EndTime": "sample string 5", "SchedulePolicy": "sample string 6", "CostCenter1": "sample string 7", "CostCenter2": "sample string 8", "CostCenter3": "sample string 9", "CostCenter4": "sample string 10", "CostCenter5": "sample string 11", "Job": "sample string 12", "Task": "sample string 13", "OverrideProfile": "sample string 14", "TimeClockScheduleID": 15, "ShiftNumber": 16 } ]
application/xml, text/xml
<ArrayOfScheduleMetaData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.TimeAttendance.WebAPI.Models"> <ScheduleMetaData> <CostCenter1>sample string 7</CostCenter1> <CostCenter2>sample string 8</CostCenter2> <CostCenter3>sample string 9</CostCenter3> <CostCenter4>sample string 10</CostCenter4> <CostCenter5>sample string 11</CostCenter5> <EmployeeNumber>sample string 1</EmployeeNumber> <EndDate>sample string 4</EndDate> <EndTime>sample string 5</EndTime> <Job>sample string 12</Job> <OverrideProfile>sample string 14</OverrideProfile> <SchedulePolicy>sample string 6</SchedulePolicy> <ShiftNumber>16</ShiftNumber> <StartDate>sample string 2</StartDate> <StartTime>sample string 3</StartTime> <Task>sample string 13</Task> <TimeClockScheduleID>15</TimeClockScheduleID> </ScheduleMetaData> <ScheduleMetaData> <CostCenter1>sample string 7</CostCenter1> <CostCenter2>sample string 8</CostCenter2> <CostCenter3>sample string 9</CostCenter3> <CostCenter4>sample string 10</CostCenter4> <CostCenter5>sample string 11</CostCenter5> <EmployeeNumber>sample string 1</EmployeeNumber> <EndDate>sample string 4</EndDate> <EndTime>sample string 5</EndTime> <Job>sample string 12</Job> <OverrideProfile>sample string 14</OverrideProfile> <SchedulePolicy>sample string 6</SchedulePolicy> <ShiftNumber>16</ShiftNumber> <StartDate>sample string 2</StartDate> <StartTime>sample string 3</StartTime> <Task>sample string 13</Task> <TimeClockScheduleID>15</TimeClockScheduleID> </ScheduleMetaData> </ArrayOfScheduleMetaData>