This GET endpoint returns schedule details based on the XRefCodes that you enter.
Parameters
Consumers can retrieve employee schedules data using the following parameters.
| Parameter | Description |
|---|---|
|
filterScheduleStartDate |
The start date of the range to retrieve schedules from. |
|
filterScheduleEndDate |
The end date of the range to retrieve schedules from. |
|
employeeXRefCode |
(Optional) The cross-reference codes of the employees to retrieve schedules from. |
| departmentXRefCode | (Optional) The cross-reference codes of the departments to retrieve schedules from. |
| jobXRefCode | (Optional) The cross-reference codes of the employees to retrieve schedules from. |
| positionXRefCode | (Optional) The cross-reference codes of the positions to retrieve schedules from. |
| orgUnitXRefCode | (Optional) The cross-reference codes of the org units to retrieve schedules from. |
| unfill | Enter TRUE to retrieve all unfilled shifts. |
| pageSize | The number of records returned per page in the response. |
Response
The response is in JSON format as illustrated in the example below:
{
"Data": [
{
"EmployeeScheduleXRefCode": "string",
"EmployeeXRefCode": "string",
"TimeStart": "2023-10-18T16:35:51.656Z",
"TimeEnd": "2023-10-18T16:35:51.656Z",
"NetHours": 0,
"DepartmentXRefCode": "string",
"JobXRefCode": "string",
"PositionXRefCode": "string",
"OrgUnitXRefCode": "string",
"SiteOrgUnitXRefCode": "string",
"OrgLocationTypeXRefCode": "string",
"PayAdjCodeXRefCode": "string",
"DocketXRefCode": "string",
"ProjectXRefCode": "string",
"Comment": "string",
"Published": true,
"Breaks": [
{
"TimeStart": "2023-10-18T16:35:51.656Z",
"TimeEnd": "2023-10-18T16:35:51.656Z",
"NetHours": 0,
"Type": "string"
}
],
"Activities": [
{
"TimeStart": "2023-10-18T16:35:51.656Z",
"TimeEnd": "2023-10-18T16:35:51.656Z",
"XRefCode": "string"
}
],
"Skills": [
{
"SkillXRefCode": "string",
"SkillLevelXRefCode": "string",
"IsMandatory": true
}
],
"LaborMetrics": [
{
"CodeXRefCode": "string",
"TypeXRefCode": "string"
}
],
"Segments": [
{
"TimeStart": "2023-10-18T16:35:51.656Z",
"TimeEnd": "2023-10-18T16:35:51.656Z",
"NetHours": 0,
"DepartmentXRefCode": "string",
"JobXRefCode": "string",
"PositionXRefCode": "string",
"OrgUnitXRefCode": "string",
"OrgLocationTypeXRefCode": "string",
"PayAdjCodeXRefCode": "string",
"DocketXRefCode": "string",
"ProjectXRefCode": "string",
"Comment": "string",
"LaborMetrics": [
{
"CodeXRefCode": "string",
"TypeXRefCode": "string"
}
]
}
],
"IsPostedShiftBid": true
}
],
"ProcessResults": [
{
"Code": "string",
"Context": "string",
"Level": "string",
"Message": "string"
}
],
"Paging": {
"Next": "string"
}
}