Dayforce RESTful Web Services Developer Guide

Version: R2024.2.1

About This Guide
Before You Begin
Getting Started with RESTful Web Services
Integrate with the REST Service
Create a Sample .NET Console Client Application
Create a Project
Add a Reference
Add Source Code
Authentication
Add the Web Services Role Feature
Token-Based Authentication
Request an Access Token
Request Dayforce APIs Using an Access Token
Determine Which URL to Use
HTTP Verbs
REST Services for Retrieving Employee Information
REST Services for Updating Employee Information
POST and PATCH Employee Subordinate Resources
ProcessResult Messages
REST Service for Adding Employee Information
RESTful Add and Update Background Screening Data
POST Background Screening Billing Codes
POST Background Screening Packages
POST Background Screening Provider Statuses
PATCH Candidate Background Screening
PATCH Candidate Background Screening Right to Work
PATCH Candidate Background Screening Personal Identifiable Information
PATCH Candidate Background Screening Adjudication Status
PATCH Candidate Background Screening Status
Background Screening Data Models
Response Body Schema Description
RESTful Retrieve Department Data
RESTful Get Department XRefCodes
RESTful Get Department Details
RESTful Add and Update Departments
POST Department Data
PATCH Department Data
RESTful Add and Update Positions
POST Position Data
PATCH Position Data
RESTful Retrieve Position Data
RESTful Get Position XRefCodes
RESTful Get Position Details
RESTful Add and Update Jobs
POST Job Data
PATCH Job Data
RESTful Retrieve Job Data
RESTful Get Job XRefCodes
RESTful Get Job Details
RESTful Retrieve HR Admin Data
RESTful Get HR Admin XRefCodes
RESTful Get HR Admin Details
REST Services for Retrieving WFM Data
RESTful Retrieve Employee Retro Data
RESTful Add and Update Employee Pay Adjustment Data
POST Employee Pay Adjustments
PATCH Employee Pay Adjustments Data
RESTful Retrieve Job Step Rates
RESTful Retrieve, Add, and Update Employee Schedules
GET Employee Schedules
POST Employee Schedules
PATCH Employee Schedules
RESTful Retrieve Org Unit Data
RESTful Get Org Unit XRefCodes
RESTful Get Org Unit Details
RESTful Add and Update Org Units
POST Org Unit Data
PATCH Org Unit Data
RESTful Add Employee Availability Data
POST Availability
REST Service for Adding Employee Raw Clock Entries
RESTful Delete Employee Punches
RESTful Retrieve Labor Metrics
RESTful Get Labor Metrics XRefCodes
RESTful Get Labor Metric Type XRefCodes
RESTful Add and Update Labor Metrics
POST Labor Metrics
PATCH Labor Metrics
POST Labor Metric Types
PATCH Labor Metric Types
RESTful Retrieve and Delete Legacy Labor Metrics
RESTful Get Legacy Labor Metrics
RESTful Delete Legacy Labor Metrics
RESTful Add and Update Legacy Labor Metrics
POST Legacy Labor Metrics
PATCH Legacy Labor Metrics
RESTful Get KPI Data
POST and PATCH KPI Data
POST KPI Data
PATCH KPI Data
RESTful Get Plan Targets
POST and PATCH Plan Targets
PATCH Plan Targets
POST Plan Targets
RESTful Get Operating Hours
POST and PATCH Operating Hours
POST Operating Hours
PATCH Operating Hours
RESTful Retrieve Projects Data
RESTful Add and Update Projects Data
POST Projects Data
PATCH Projects Data
REST Services for Retrieving Documents
REST Services for Retrieving Report Metadata and Report Data
REST Services for Updating an Employee's I-9 Order Status
REST Services for Retrieving Job Posting Feeds
Integrations with Candidate Assessment Providers
RESTful GET Assessment List
RESTful POST Candidate Assessment Registration
RESTful POST Candidate Assessment Status
RESTful POST Candidate Reports
RESTful POST Candidate Scores
Pagination of Response Data
Data Authorization and Filtering
Field Level Filtering
Access Authorizations
Check for Errors

Back to home page