RESTful POST Candidate Assessment Registration

Dayforce RESTful Web Services Developer Guide

Version
R2025.2.1
RESTful POST Candidate Assessment Registration

The POST Candidate Assessment Registration request allows Dayforce to register candidates for assessments. The assessment link is expected as part of the response to this request. Dayforce sends the link to candidates for them to complete the assessment.

The following is a sample request that Dayforce sends to providers:

{
    "CreationDateTime": "2019-11-20T07:34:38.4435297Z",
    "Candidate": {
        "FirstName": "FSample",
        "LastName": "LSample",
        "EmailAddress": "Email@sample.com",
        "Language": "en-us",
	 "CandidateId": 1234,
	 "IsCandidateInternal": true,
        "CandidateAssessmentGuid": "6015AA33-5E91-41DE-994A-0F4C7F8FED6F"
    },
    "JobReqInfo": {
    "JobReqId": 123,
    "JobReqName": "The job requisition name",
    "DepartmentName": "Department name",
    "OrgInfo": {
	"ShortName": "wo",
	"Address": "123 address",
	"Address2": "Address 2",
	"StateCode": "state code",
	"PostalCode": "12345",
	"CountryCode": "USA",
	"PhysicalLocation": true
       }
    },		
    "AssessmentReference": "C#",
    "PushBackLinks": {
        "Scores": "https://pushbackurl.com/scores",
        "Reports": "https://pushbackurl.com/reports"
    }
}
Response schema parameters
Parameters Description

CreationDateTime

Date the details were sent/received

AssessmentURL*

Candidate assessment URL

CandidateAssessmentGuid*

Dayforce candidate assessment reference

ReceiptId

Provider candidate assessment reference

StatusInfo*

Information about the request status

Code*

Status of the request

Message

Additional message about any errors

The following is a sample response that Dayforce is expecting from the provider. Note that the ReceiptId is the assessment provider’s unique identifier for the assessment request:

{
    "CreationDateTime": "2019-11-20T10:12:00.9402311Z",
    "AssessmentURL": "http://sample-assessment-url.com",
    "CandidateAssessmentGuid": "6015AA33-5E91-41DE-994A-0F4C7F8FED6F",
    "ReceiptId": "123",
    "StatusInfo": {
        "Code": "Success"
    }
}