RESTful Get Operating Hours

In Dayforce, operating hours describe when locations are open during each day of the week, exceptions to this pattern, when the pattern is applied, and what locations it's applied to. This RESTful operation retrieves locations' operating hours.

Overview

Operating hours can be retrieved for specified locations and periods. The call URL is constructed using the following base URL:

https://www.dayforcehcm.com/api/CompanyName/V1/OperatingHours/GetOperatingHours

Parameters

startDate (string)

• The start date used to determine the operating hours to retrieve. If omitted, the current date is used.

endDate (string)

• The end date used to determine the operating hours to retrieve. If omitted, the period start date is used. If the period start date is also omitted, the current date is used.

orgUnitId (integer)

• The org unit IDs to determine the locations to retrieve operating hours for.

clientNamespace (string)

• Uniquely identifies the client's Dayforce instance. This is needed to log in.

Response

The response is in JSON format as illustrated in the example below:

{
  "Data": {
    "EffectiveStart": "2023-07-31T19:11:11.967Z",
    "EffectiveEnd": "2023-07-31T19:11:11.967Z",
    "OrgUnit": 0,
    "OperatingHours": [
      {
        "Day": "2023-07-31T19:11:11.967Z",
        "IsClosed": 0,
        "NoDayPattern": 0,
        "ShortName": "string",
        "LongName": "string",
        "OpenTime": "2023-07-31T19:11:11.967Z",
        "CloseTime": "2023-07-31T19:11:11.967Z",
        "IsException": 0,
        "LastModifiedTimestamp": "2023-07-31T19:11:11.967Z",
        "Client": 0
      }
    ]
  },
  "ProcessResults": [
    {
      "Code": "string",
      "Context": "string",
      "Level": "string",
      "Message": "string"
    }
  ]
}