Skip to content

Working with Employee Work Assignment Managers

[Overview] [Operation details] [Sample configuration]

Overview

The following operations allow you to retrieve, create or update work assignment managers of an employee

Operation Description
GET Employee Work Assignment Managers Retrieve managers assigned to an employee through Direct Management.
POST Employee Work Assignment Managers Assign managers to an employee through Direct Management.
PATCH Employee Work Assignment Managers Update the managers assigned to an employee through Direct Management.

Operation details

This section provides more details on each of the operations.

Retrieving Employee Work Assignment Managers

We can use GET Employee Work Assignment Managers operation with required parameters to find the work assignment manager of employees.

GET Employee Work Assignment Managers

<ceridiandayforce.getEmployeeWorkAssignmentManagers>
    <xRefCode>{$ctx:xRefCode}</xRefCode>
    <contextDate>{$ctx:contextDate}</contextDate>
    <contextDateRangeFrom>{$ctx:contextDateRangeFrom}</contextDateRangeFrom>
    <contextDateRangeTo>{$ctx:contextDateRangeTo}</contextDateRangeTo>
</ceridiandayforce.getEmployeeWorkAssignmentManagers>

Properties

  • xRefCode (Mandatory): The unique identifier (external reference code) of the employee whose data will be retrieved. The value provided must be the exact match for an employee; otherwise, a bad request (400) error will be returned.
  • contextDate (Optional): The Context Date value is an “as-of” date used to determine which employee data to search when records have specific start and end dates. The service defaults to the current datetime if the requester does not specify a value. Example: 2017-01-01T13:24:56
  • contextDateRangeFrom (Optional): The Context Date Range From value is the start of the range of dates used to determine which employee data to search when records have specific start and end dates. The service defaults to null if the requester does not specify a value. Example: 2017-01-01T13:24:56
  • contextDateRangeTo (Optional): The Context Date Range To value is the end of the range of dates to determine which employee data to search when records have specific start and end dates. The service defaults to null if the requester does not specify a value. Example: 2017-01-01T13:24:56

Sample request

Following is a sample request that can be handled by this operation.

{
  "username": "DFWSTest",
  "password": "DFWSTest",
  "clientNamespace": "usconfigr57.dayforcehcm.com/Api/ddn",
  "apiVersion": "V1",
  "xRefCode": "42199"
}

Sample response

Given below is a sample response for this operation.

{
    "Data": [
        {
            "EffectiveStart": "2000-01-01T00:00:00",
            "EmploymentStatusGroupXRefCode": "INACTIVE",
            "ManagerXRefCode": "62779",
            "ManagerName": "Macon Burke",
            "ActiveEmployeePosition": {
                "XRefCode": "Packaging Packager",
                "ShortName": "Package Handler"
            },
            "ActiveEmployeeLocation": {
                "XRefCode": "500Packaging",
                "ShortName": "Plant 1 - Packaging"
            }
        }
    ]
}

Related Dayforce documentation

https://developers.dayforce.com/Build/API-Explorer/User-Security,-Authority-Management/Work-Assignment-Managers/GET-Employee-Work-Assignment-Managers.aspx

Creating Employee Work Assignment Managers

We can use POST Employee Work Assignment Managers operation with required parameters to create work assignment managers of an employee.

POST Employee Work Assignment Managers

<ceridiandayforce.postEmployeeWorkAssignmentManagers>
    <xRefCode>{$ctx:xRefCode}</xRefCode>
    <isValidateOnly>{$ctx:isValidateOnly}</isValidateOnly>
    <fieldAndValue>{$ctx:fieldAndValue}</fieldAndValue>
</ceridiandayforce.postEmployeeWorkAssignmentManagers>

Properties

  • xRefCode (Mandatory): The unique identifier (external reference code) of the employee whose data will be retrieved. The value provided must be the exact match for an employee; otherwise, a bad request (400) error will be returned.
  • isValidateOnly (Mandatory): When a TRUE value is used in this parameter, POST and PATCH operations validate the request without applying updates to the database.

Sample request

Following is a sample request that can be handled by this operation.

{
  "username": "DFWSTest",
  "password": "DFWSTest",
  "clientNamespace": "usconfigr57.dayforcehcm.com/Api/ddn",
  "apiVersion": "V1",
  "xRefCode": "42199",
  "isValidateOnly": "true",
  "fieldAndValue": {
            "EffectiveStart": "2000-01-01T00:00:00",
            "EmploymentStatusGroupXRefCode": "INACTIVE",
            "ManagerXRefCode": "62779",
            "ManagerName": "Macon Burke",
            "ActiveEmployeePosition": {
                "XRefCode": "Packaging Packager",
                "ShortName": "Package Handler"
            },
            "ActiveEmployeeLocation": {
                "XRefCode": "500Packaging",
                "ShortName": "Plant 1 - Packaging"
            }
        }
}

Sample response

Dayforce returns HTTP Code 200

Related Dayforce documentation

https://developers.dayforce.com/Build/API-Explorer/User-Security,-Authority-Management/Work-Assignment-Managers/POST-Employee-Work-Assignment-Managers.aspx

Updating Employee Work Assignment Managers

We can use PATCH Employee Work Assignment Managers operation with required parameters to update the work assignment managers of an employee

PATCH Employee Work Assignment Managers

<ceridiandayforce.patchEmployeeWorkAssignmentManagers>
    <xRefCode>{$ctx:xRefCode}</xRefCode>
    <isValidateOnly>{$ctx:isValidateOnly}</isValidateOnly>
    <fieldAndValue>{$ctx:fieldAndValue}</fieldAndValue>
</ceridiandayforce.patchEmployeeWorkAssignmentManagers>

Properties

  • xRefCode (Mandatory): The unique identifier (external reference code) of the employee whose data will be retrieved. The value provided must be the exact match for an employee; otherwise, a bad request (400) error will be returned.
  • isValidateOnly (Mandatory): When a TRUE value is used in this parameter, POST and PATCH operations validate the request without applying updates to the database.

Sample request

Following is a sample request that can be handled by this operation.

{
  "username": "DFWSTest",
  "password": "DFWSTest",
  "clientNamespace": "usconfigr57.dayforcehcm.com/Api/ddn",
  "apiVersion": "V1",
  "xRefCode": "42199",
  "isValidateOnly": "true",
  "fieldAndValue": {
            "EffectiveStart": "2000-01-01T00:00:00",
            "EmploymentStatusGroupXRefCode": "INACTIVE",
            "ManagerXRefCode": "62779",
            "ManagerName": "Macon Burke",
            "ActiveEmployeePosition": {
                "XRefCode": "Packaging Packager",
                "ShortName": "Package Handler"
            },
            "ActiveEmployeeLocation": {
                "XRefCode": "500Packaging",
                "ShortName": "Plant 1 - Packaging"
            }
        }
}

Sample response

Dayforce returns HTTP Code 200

Related Dayforce documentation

https://developers.dayforce.com/Build/API-Explorer/User-Security,-Authority-Management/Work-Assignment-Managers/PATCH-Employee-Work-Assignment-Managers.aspx

Sample configuration

Following example illustrates how to connect to Dayforce with the init operation and query operation.

1.Create a sample proxy as below :

<?xml version="1.0" encoding="UTF-8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="query"
       startOnLoad="true"
       statistics="disable"
       trace="disable"
       transports="http,https">
   <target>
      <inSequence>
         <log level="full" separator=","/>
         <property expression="json-eval($.username)" name="username"/>
         <property expression="json-eval($.password)" name="password"/>
         <property expression="json-eval($.clientNamespace)" name="clientNamespace"/>
         <property expression="json-eval($.apiVersion)" name="apiVersion"/>
         <property expression="json-eval($.xRefCode)" name="xRefCode"/>
         <ceridiandayforce.init>
            <username>{$ctx:username}</username>
            <password>{$ctx:password}</password>
            <clientNamespace>{$ctx:clientNamespace}</clientNamespace>
            <apiVersion>{$ctx:apiVersion}</apiVersion>
         </ceridiandayforce.init>
         <ceridiandayforce.getEmployeeWorkAssignmentManagers>
            <xRefCode>{$ctx:xRefCode}</xRefCode>
         </ceridiandayforce.getEmployeeWorkAssignmentManagers>
         <send/>
      </inSequence>
   </target>
   <description/>
</proxy>

2.Create a json file named query.json and copy the configurations given below to it:

{
  "username": "DFWSTest",
  "password": "DFWSTest",
  "clientNamespace": "usconfigr57.dayforcehcm.com/Api/ddn",
  "apiVersion": "V1",
  "xRefCode": "42199"
}
3.Replace the credentials with your values.

4.Execute the following curl command:

curl http://localhost:8280/services/query -H "Content-Type: application/json" -d @query.json
5.Dayforce returns HTTP Code 200 with the following response body

{
    "Data": [
        {
            "EffectiveStart": "2000-01-01T00:00:00",
            "EmploymentStatusGroupXRefCode": "INACTIVE",
            "ManagerXRefCode": "62779",
            "ManagerName": "Macon Burke",
            "ActiveEmployeePosition": {
                "XRefCode": "Packaging Packager",
                "ShortName": "Package Handler"
            },
            "ActiveEmployeeLocation": {
                "XRefCode": "500Packaging",
                "ShortName": "Plant 1 - Packaging"
            }
        }
    ]
}
Top