After Enhanced Employee Gender is enabled, customers can keep using the legacy gender and gender identity endpoints in the RESTful API and other API-based integrations. Through backward compatibility, these endpoints continue to work with Enhanced Employee Gender. Some configuration notes and limitations are described below.
What Are API Integrations?
The RESTful API can be called by different integration methods including:
- DF Link
- Integration Studio
- Internally in Dayforce
- Calls from external sources
These calls allow customers to request information from Dayforce, push information from their own systems, or update existing records without using an XML HR Import file or making changes in Dayforce. Many customers choose this method because it provides more direct and efficient access to Dayforce HR data.
What Is Backward Compatibility?
With backward compatibility, customers can keep using existing gender and gender identity elements with the new Enhanced Employee Gender functionality.
For the RESTful API, backward compatibility means that customers can keep using Dayforce without changes to their experience. The legacy gender and gender identity endpoints are still in the Employee entity, and they import the records into the new Enhanced Employee Gender record for the employee.
Backward Compatibility Limitations
Backward compatibility has some limitations. With certain configurations, backward compatibility doesn’t work and you receive validation errors during GET, POST, and PATCH API requests. If this happens, you must update your Dayforce configuration to use Enhanced Employee Gender. The limitations are described below.
Display Enhanced Employee Gender Last Modification Information and Effective Dating client property is enabled
If the Display Enhanced Employee Gender Last Modification Information and Effective Dating client property is enabled, effective dated gender records can be assigned to employees. The legacy gender and gender identity endpoints can’t accept effective dated records, so Enhanced Employee Gender isn’t backward compatible with this client property enabled.
See Enabling the Display Enhanced Gender Last Modification and Effective Dating Client Property.
The Gender module is configured for a country, state, or province
After the migration, if you change any of the following settings for a country, state, or province in HR Admin > Employee Gender Admin > Gender, backward compatibility doesn’t work and you’ll receive validation errors because the legacy endpoints can’t accept this data:
- The Collect Assigned Sex Information checkbox is cleared
- The Make Assigned Sex Mandatory checkbox is cleared
- The Gender Identity checkbox is cleared
- You add custom-assigned sex values (not system M or F) for a country, state, or province
See Enhanced Employee Gender Administration Screen and the Compliance Framework.
An employee has multiple gender records
With Enhanced Employee Gender, employees can have a gender record for each location they live in, work from, or want to be reported in. However, the endpoints can accept only one record, so multiple gender records aren’t backward compatible.
See Confidential Information Updates.
An employee in the United States or Canada has state or province gender records
With Enhanced Employee Gender, an employee in the United States or Canada must have a state or province value assigned to their gender records. They also have a country gender record. In this case, validation doesn’t fail, but backward compatibility can update only the country gender record. State or province records are ignored, and only the country record is updated.
The tables below and after illustrate how an employee’s gender record is updated with backward compatibility.
| Country | State | Assigned Sex | Gender Identity | “isFederal” Flag |
|---|---|---|---|---|
| United States | NULL (blank) | Male | NULL (blank) | 1 OR 0 |
| United States | Florida | Male | Female | NULL (Blank, not applicable) |
And the below RESTful API backward-compatible record is supplied for the employee:
- Gender: Female
| Country | State | Assigned Sex | Gender Identity | “isFederal” Flag |
|---|---|---|---|---|
| United States | NULL (blank) | Female | NULL (blank) | 1 OR 0 |
| United States | Florida | Male | Female | NULL (Blank, not applicable) |
Other Resources
- For information about the RESTful API see the Dayforce Developer Network.
- For information about Integration Studio, see the Dayforce Integration Studio Administrator Guide.
- For customers who want to use Enhanced Employee Gender with API integrations, see Migrate API-Based Integrations.