Service Directory > v31.2 > Recruiting > Assess_Candidate
 

Operation: Assess_Candidate

Create or modify a Candidate Assessment. The Job Application business process relevant to the candidate must be in the Assess Candidate state.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Assess_Candidate_Request

A request to create or modify a Candidate Assessment.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Dynamic_Business_Process_Parameters  Dynamic_Business_Process_Parameters  [0..1]  Container for the processing options for a dynamic business process. If no options are submitted, the process does not move to the next stage or disposition. 
Validation Description
The next step or disposition chosen is invalid for the job application process.   
 
Assess_Candidate_Data  Assess_Candidate_Event_Data  [1..1]  References to the Candidate Assessment to be created or modified along with the data to be used in the creation or modification. 
Validation Description
An inline assessment must have a Job Application specified, and cannot be associated with an Assessment Event.   
 
Validation Description
The Job Application business process relevant to the candidate must be in the Assess Candidate state to use Dynamic Business Process Parameters to Move Forward or Decline.   
The Candidate was never in the Assessment Business Process to add or update a Candidate Assessment.   
top
 

Response Element: Assess_Candidate_Response

The result of an attempt to create or modify a Candidate Assessment.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Candidate_Assessment_Event_Reference  Unique_IdentifierObject  [0..1]  A reference to the modified or created Candidate Assessment Event.   
Candidate_Assessment_Reference  Recruiting_AssessmentObject  [0..1]  A reference to the modified or created Candidate Assessment.   
top
 

Dynamic_Business_Process_Parameters

part of: Assess_Candidate_Request
Container for the processing options for a dynamic business process. If no options are submitted, the process does not move to the next stage or disposition.
 
Parameter name Type/Value Cardinality Description Validations
Next_Step_Reference [Choice]   Workflow_StepObject  [1..1]  Sends the dynamic business process to the next specified sub-process. This must be a valid next stage based off the current stage of the dynamic business process and the allowed next steps in its definition.   
Disposition_Step_Reference [Choice]   Workflow_StepObject  [1..1]  The disposition step for the dynamic business process. This must be a valid disposition step for the current stage of the business process according to the business process definition.   
Comment_Data  Business_Process_Comment_Data  [0..*]  Captures a comment for the Business Process.   
Validation Description
The next step or disposition chosen is invalid for the job application process.   
top
 

Workflow_StepObject

part of: Dynamic_Business_Process_Parameters, Dynamic_Business_Process_Parameters
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Workflow_StepObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Workflow_StepObjectID

part of: Workflow_StepObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Workflow_Step_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Business_Process_Comment_Data

part of: Dynamic_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

part of: Business_Process_Comment_Data, Recruiting_Assessment_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

part of: WorkerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Employee_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Assess_Candidate_Event_Data

part of: Assess_Candidate_Request
References to the Candidate Assessment to be created or modified along with the data to be used in the creation or modification.
 
Parameter name Type/Value Cardinality Description Validations
Event_Reference [Choice]   Unique_IdentifierObject  [1..1]  A reference to the Assess Candidate business process event.   
Job_Application_Reference [Choice]   Job_ApplicationObject  [1..1]  A reference to the Job Application relevant to the Candidate Assessment underway.   
Candidate_Criteria_Data [Choice]   Candidate_Criteria  [1..1]  A Candidate and optional Job Requisition reference that should be used to create or modify a Candidate Assessment.   
Candidate_Assessment_Data  Recruiting_Assessment_Data  [1..1]  The data used to create or modify a Candidate Assessment.   
Validation Description
An inline assessment must have a Job Application specified, and cannot be associated with an Assessment Event.   
top
 

Unique_IdentifierObject

part of: Assess_Candidate_Response, Assess_Candidate_Event_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Job_ApplicationObject

part of: Assess_Candidate_Event_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Job_ApplicationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Job_ApplicationObjectID

part of: Job_ApplicationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Job_Application_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Candidate_Criteria

part of: Assess_Candidate_Event_Data
A Candidate and optional Job Requisition reference that should be used to create or modify a Candidate Assessment.
 
Parameter name Type/Value Cardinality Description Validations
Candidate_Reference  CandidateObject  [1..1]  A reference to the Candidate.   
Job_Requisition_Reference  Job_Requisition_EnabledObject  [0..1]  A reference to a Job Requisition that combined with the Candidate reference should result in precisely one Job Application with an in progress Candidate Assessment Event.   
top
 

CandidateObject

part of: Candidate_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CandidateObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CandidateObjectID

part of: CandidateObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Candidate_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Job_Requisition_EnabledObject

part of: Candidate_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Job_Requisition_EnabledObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Job_Requisition_EnabledObjectID

part of: Job_Requisition_EnabledObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Job_Requisition_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Recruiting_Assessment_Data

part of: Assess_Candidate_Event_Data
The data used to create or modify a Candidate Assessment.
 
Parameter name Type/Value Cardinality Description Validations
Assess_Candidate_Reference  string  [0..1]  The unique identifier for a candidate assessment. Should no other references be provided this identifier is used to find an existing Candidate Assessment. Otherwise, this identifier will be saved as part of the Candidate Assessment.   
Assessed_By_Reference  WorkerObject  [0..1]  A reference to the person that provides the Candidate Assessment information.   
Assessed_On_Date  date  [1..1]  The date upon which the Candidate Assessment was or will be performed.   
Assessment_Status_Reference  Recruiting_Assessment_StatusObject  [1..1]  A reference to existing Assessment Statuses as defined in the tenant set up.   
Overall_Assessment_Comment  string  [0..1]  An overall comment on the Candidate Assessment.   
Is_Inline_Assessment  boolean  [0..1]  This assessment is for an inline assessment test.   
Assessment_Test_URL  string  [0..1]  URL for the candidate assessment test.   
Assess_Candidate_Test_Result_Data  Recruiting_Assessment_Test_Result_Data  [0..*]  Information on a set of Assessment Test Results used in concert with the Candidate Assessment. 
Validation Description
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
 
top
 

Recruiting_Assessment_StatusObject

part of: Recruiting_Assessment_Data, Recruiting_Assessment_Test_Result_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Recruiting_Assessment_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Recruiting_Assessment_StatusObjectID

part of: Recruiting_Assessment_StatusObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Assessment_Status_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Recruiting_Assessment_Test_Result_Data

part of: Recruiting_Assessment_Data
A collection of information on the Assessment Test Results used in the Candidate Assessment.
 
Parameter name Type/Value Cardinality Description Validations
Assessment_Test_Result_Reference  Recruiting_Assessment_Test_ResultObject  [0..1]  A reference to an individual Assessment Test Result.   
Assessment_Test_Reference  Recruiting_Assessment_TestObject  [1..1]  The Assessment Test used to produce the Test Result.   
Assessment_Test_Score  decimal (18, 6)   [0..1]  The score the Candidate was given for the referenced Assessment Test.   
Assessment_Test_Status_Reference  Recruiting_Assessment_StatusObject  [0..1]  A reference to the tenant supplied status for this Assessment Test Result. For example, if the test outcome was satisfactory or not.   
Assessment_Test_Date  date  [0..1]  The date that the test was taken or when the result was recorded.   
Comment  string  [0..1]  A comment on the Assessment Test Result.   
Assessment_Test_Results_URL  string  [0..1]  The vendor URL for the assessment results.   
Validation Description
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
top
 

Recruiting_Assessment_Test_ResultObject

part of: Recruiting_Assessment_Test_Result_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Recruiting_Assessment_Test_ResultObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Recruiting_Assessment_Test_ResultObjectID

part of: Recruiting_Assessment_Test_ResultObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Assessment_Test_Result_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Recruiting_Assessment_TestObject

part of: Recruiting_Assessment_Test_Result_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Recruiting_Assessment_TestObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Recruiting_Assessment_TestObjectID

part of: Recruiting_Assessment_TestObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Assessment_Test_ID, Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Recruiting_AssessmentObject

part of: Assess_Candidate_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Recruiting_AssessmentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Recruiting_AssessmentObjectID

part of: Recruiting_AssessmentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Recruiting_Assessment_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Workflow_StepReferenceEnumeration

part of: Workflow_StepObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Job_ApplicationReferenceEnumeration

part of: Job_ApplicationObjectID
Base Type
string
top
 

CandidateReferenceEnumeration

part of: CandidateObjectID
Base Type
string
top
 

Job_Requisition_EnabledReferenceEnumeration

part of: Job_Requisition_EnabledObjectID
Base Type
string
top
 

Recruiting_Assessment_StatusReferenceEnumeration

part of: Recruiting_Assessment_StatusObjectID
Base Type
string
top
 

Recruiting_Assessment_Test_ResultReferenceEnumeration

part of: Recruiting_Assessment_Test_ResultObjectID
Base Type
string
top
 

Recruiting_Assessment_TestReferenceEnumeration

part of: Recruiting_Assessment_TestObjectID
Base Type
string
top
 

Recruiting_AssessmentReferenceEnumeration

part of: Recruiting_AssessmentObjectID
Base Type
string
top