PATCH Employee Schedules

Dayforce RESTful services use the PATCH endpoint to create an instance of the resource. In the case of the Employee Schedules resource, PATCH  refers to creating new shifts.

Endpoint URL

The URL for PATCH 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

Use the PATCH endpoint to do the following:

• Create an effective-dated subordinate record (LaborMetrics).
• Update an existing schedule for an employee or a currently-effective subordinate record.

The URL for PATCH operations uses the base URL and employee schedules XRefCode:

https://www.dayforcehcm.com/api/CompanyName/V1/EmployeeSchedules

You must include the XRefCode in the request URL because Dayforce web services assumes that the requester means to update an existing employee schedule when PATCH is used.

The request body needs to include only the data entities and elements that need to be inserted or updated. The request doesn't need to include values for all of the information available in the employee schedules data model.

Additionally, you assume the responsibility for committing data to your instance of Dayforce web services. If data isn’t to be committed (for example, test data in a production instance), you must send the request using the parameter and value IsValidateOnly=true.

Important: This request modifies existing data in 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 modifying the wrong Dayforce instance (for example, test data in a production instance).

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

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.
• The URL syntax is: https://www.dayforcehcm.com/api/CompanyName/V1/EmployeeSchedules?isValidateOnly=true

Request Body

The request body contains the data entities and elements that need to be processed within a structure that can be interpreted by Dayforce web services. The same JSON structure used to return data retrieved from Dayforce using the RESTful GET EmployeeSchedules request is used for PATCH operations.

[
  {
    "EmployeeScheduleXRefCode": "string",
    "TimeStart": "2023-10-18T16:15:16.446Z",
    "TimeEnd": "2023-10-18T16:15:16.446Z",
    "IsDeleted": true,
    "EmployeeXRefCode": "string",
    "PostShiftBid": true,
    "Breaks": [
      {
        "TimeStart": "2023-10-18T16:15:16.446Z",
        "TimeEnd": "2023-10-18T16:15:16.446Z",
        "Type": 1
      }
    ],
    "Activities": [
      {
        "XRefCode": "string",
        "TimeStart": "2023-10-18T16:15:16.446Z",
        "TimeEnd": "2023-10-18T16:15:16.446Z"
      }
    ],
    "Segments": [
      {
        "TimeStart": "2023-10-18T16:15:16.446Z",
        "TimeEnd": "2023-10-18T16:15:16.446Z",
        "PositionXRefCode": "string",
        "DocketXRefCode": "string",
        "PayAdjCodeXRefCode": "string",
        "OrgLocationTypeXRefCode": "string",
        "ProjectXRefCode": "string",
        "Comment": "string",
        "LaborMetrics": [
          {
            "CodeXRefCode": "string",
            "TypeXRefCode": "string"
          }
        ]
      }
    ],
    "PositionXRefCode": "string",
    "DocketXRefCode": "string",
    "PayAdjCodeXRefCode": "string",
    "OrgLocationTypeXRefCode": "string",
    "ProjectXRefCode": "string",
    "Comment": "string",
    "LaborMetrics": [
      {
        "CodeXRefCode": "string",
        "TypeXRefCode": "string"
      }
    ]
  }
]