- 9 views
Here is a concise list of the error and response codes for Scheduling APIs to help identify the status and issues of API requests:
Scheduling API Response Codes
- 200 - SUCCESS
- Description: Successful response for fetching data.
- Applicable to:
- Get Units Schedule for Given Date Range
- Get Unit Schedule for a Week Based on the Given Fiscal Week Start Date
- Get Unit Shifts for Date Range
- Get Unit Open Shifts for Date Range
- Get Employee Shifts for Date Range
- 200 - NO_RECORDS_FOUND
- Description: No records found for the provided query parameters.
- Applicable to:
- Get Unit Open Shifts for Date Range
Scheduling API Error Codes
- 400 - SCH-SCH-INVALID-INSTANCETYPE
- Description: Invalid instanceType provided.
- 400 - CM-UI-INVALIDSTARTDATE
- Description: Invalid Start Date provided.
- 400 - CM-UI-INVALIDENDDATE
- Description: Invalid End Date provided.
- 400 - CM-UI-INVALIDFISCALWEEKDATE
- Description: Invalid Fiscal Week Start Date provided.
- 404 - HR-EM-INVALIDEMPLOYEE
- Description: Invalid Employee ID provided.
- 404 - SCH-SCH-SCHEDULENOTGENERATED
- Description: Could not find any schedule corresponding to the provided unit ID, schedule date, or instance type.
- 404 - HR-EM-INVALIDOWNERID
- Description: Owner ID is invalid.
- 404 - HR-EM-NOACTIVEEMPLOYEE
- Description: Could not find any active colleague corresponding to the provided person ID.
- 404 - OM-UN-INVALIDUNIT
- Description: Invalid Unit ID provided.
- 422 - CM-UI-DATEOUTOFRANGE
- Description: Date should be within the fiscal week range.
- 422 - CM-UI-WEEKSNOTINRANGE
- Description: The difference between startDate and endDate should not exceed 52 weeks.
- 500 - SCH-CM-INTERNAL-SERVER-ERROR
- Description: Exception occurred while processing the request.