Dayforce RESTful services use the POST endpoint to create an instance of the resource. In the case of the EmployeeSchedules resource, POST refers to creating a new employee schedule.
Endpoint URL
The URL for POST EmployeeSchedules uses the following base URL:
https://www.dayforcehcm.com/api/CompanyName/V1/EmployeeSchedules
Important: This request writes data into Dayforce. When using this request, be sure that the consuming application/requester is using the correct Dayforce instance (for example, Test or Production). Watch out for inadvertently updating the wrong instance of Dayforce (for example, inserting test data in a production instance).
Overview
You can insert employee schedule data using the POST EmployeeSchedules endpoint. The following is a list of some of the data entities that you can create using this endpoint:
- Start Time
- End Time
- Position
- Docket Data
- Pay Category
- Docket Data
Parameters
OrgUnitXRefCode (string)
- When this parameter is included, all employee schedules in the specified org unit are returned.
- Multiple levels of the employees’ organization are searched; the search isn’t limited to department and location.
- The URL syntax is:
https://www.dayforcehcm.com/api/CompanyName/V1/EmployeeSchedules?OrgUnitXRefCode=LOC1
IsValidateOnly (boolean)
- Used to specify that all of the validations need to be performed without committing any changes.
- Use this parameter to control whether committing information to your instance of Dayforce is your responsibility. See the Important note above.
- The URL syntax is: https://www.dayforcehcm.com /api/CompanyName/V1/EmployeeSchedules?isValidateOnly=true
Request Body
The request body contains the values that need to be inserted into the available data entities. The example below shows all of the possible fields in the correct JSON format.