RESTful Get Labor Metrics XRefCodes

Dayforce RESTful Web Services Developer Guide

Version
R2025.2.1
RESTful Get Labor Metrics XRefCodes

This GET operation returns the details of a specific labor metric code based on the XRefCode you enter. The operation uses the following URL:

https://www.dayforcehcm.com/api/CompanyName/V1/LaborMetrics/xRefCode

Parameters

Consumers can retrieve labor metrics data by using the following parameter:

XRefCode (string)

The unique identifier (external reference code) of the labor metric code that will be retrieved. The value provided must be an exact match, otherwise a bad request (400) error will be returned. This setting is required.

Response

The response from this request will contain data from the referenced XRefCode. Here is an example response:

{
  "Data": {
    "Name": "string",
    "Description": "string",
    "EffectiveStart": "2022-01-07T17:35:05.182Z",
    "EffectiveEnd": "2022-01-07T17:35:05.182Z",
    "LaborMetricsCodeXRefCode": "string",
    "ClockTransferCode": "string",
    "LedgerCode": "string",
    "OrgXRefCodes": [
      "string"
    ],
    "LaborMetricsTypeXRefCode": "string"
  },
  "ProcessResults": [
    {
      "Code": "string",
      "Context": "string",
      "Level": "string",
      "Message": "string"
    }
  ]
}