Service Directory > v32.1 > Recruiting > Get_Assess_Candidate
 

Operation: Get_Assess_Candidate

Retrieve information about Candidate Assessments.


@ - 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: Get_Assess_Candidate_Request

A request for information on a Candidate Assessment.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Assess_Candidate_Request_References  [0..1]  References provided by the web service caller to indicate the Candidate Assessment information to return.   
Request_Criteria [Choice]   Assess_Candidate_Request_Criteria  [0..1]  Criteria used to determine which Candidate Assessment to return. 
Validation Description
The From Moment must be less than the To Moment.  The From Moment must be less than the To Moment. 
To submit a candidate assessment request with Request Criteria, enter at least 1 of these criteria: Job Application Reference, Candidate Criteria Data, Job Application Event Reference, From Moment, To Moment.  To submit a candidate assessment request with Request Criteria, enter at least 1 of these criteria: Job Application Reference, Candidate Criteria Data, Job Application Event Reference, From Moment, To Moment. 
 
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Assess_Candidate_Response

The response to a web service call to return information on a Candidate Assessment.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Assess_Candidate_Request_References  [0..1]  References to the Candidate Assessments to be provided to the caller.   
Request_Criteria  Assess_Candidate_Request_Criteria  [0..1]  Criteria used to determine which Candidate Assessment to be returned to the caller. 
Validation Description
The From Moment must be less than the To Moment.  The From Moment must be less than the To Moment. 
To submit a candidate assessment request with Request Criteria, enter at least 1 of these criteria: Job Application Reference, Candidate Criteria Data, Job Application Event Reference, From Moment, To Moment.  To submit a candidate assessment request with Request Criteria, enter at least 1 of these criteria: Job Application Reference, Candidate Criteria Data, Job Application Event Reference, From Moment, To Moment. 
 
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Assess_Candidate_Response_Data  [0..1]  The result of a Candidate Assessment request. Will contain the result of the added or modified Candidate Assessment.   
top
 

Assess_Candidate_Request_References

part of: Get_Assess_Candidate_Request, Get_Assess_Candidate_Response
References provided by the web service caller to indicate the Candidate Assessment information to return.
 
Parameter name Type/Value Cardinality Description Validations
Assess_Candidate_Reference [Choice]   Unique_IdentifierObject  [1..*]  A reference to the Candidate Assessment to be returned to the caller.   
Assessment_Reference [Choice]   Recruiting_AssessmentObject  [1..*]  A reference to the Assessment to be returned to the caller.   
top
 

Unique_IdentifierObject

part of: Assess_Candidate_Request_References, Assess_Candidate_Request_Criteria, Assess_Candidate_Event, Assess_Candidate_Event, Inline_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  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
 

Recruiting_AssessmentObject

part of: Assess_Candidate_Request_References
 
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
 

Assess_Candidate_Request_Criteria

part of: Get_Assess_Candidate_Request, Get_Assess_Candidate_Response
Criteria used to determine which Candidate Assessment to return.
 
Parameter name Type/Value Cardinality Description Validations
Job_Application_Reference [Choice]   Job_ApplicationObject  [0..1]  The Candidate Assessments retrieved will be those associated with the referenced Job Application.   
Candidate_Criteria_Data [Choice]   Candidate_Criteria  [0..1]  A Candidate and optional Job Requisition reference that should be used to create or modify a Candidate Assessment.   
Job_Application_Event_Reference [Choice]   Unique_IdentifierObject  [0..1]  The Candidate Assessments retrieved will be those associated with the referenced Job Application Event.   
Include_Inline_Assessments  boolean  [0..1]  Also include inline assessment tests.   
From_Moment  dateTime  [0..1]  Only assessments created on or after this moment will be retrieved.   
To_Moment  dateTime  [0..1]  Only assessments prior to this moment will be retrieved.   
Validation Description
The From Moment must be less than the To Moment.  The From Moment must be less than the To Moment. 
To submit a candidate assessment request with Request Criteria, enter at least 1 of these criteria: Job Application Reference, Candidate Criteria Data, Job Application Event Reference, From Moment, To Moment.  To submit a candidate assessment request with Request Criteria, enter at least 1 of these criteria: Job Application Reference, Candidate Criteria Data, Job Application Event Reference, From Moment, To Moment. 
top
 

Job_ApplicationObject

part of: Assess_Candidate_Request_Criteria, Assess_Candidate_Event, Inline_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  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_Request_Criteria
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, Assess_Candidate_Event, Inline_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  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, Assess_Candidate_Event, Inline_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  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
 

Response_Filter

part of: Get_Assess_Candidate_Request, Get_Assess_Candidate_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Assess_Candidate_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Assess_Candidate_Response_Data

part of: Get_Assess_Candidate_Response
The result of a Candidate Assessment request. Will contain the result of the added or modified Candidate Assessment.
 
Parameter name Type/Value Cardinality Description Validations
Assess_Candidate_Data  Assess_Candidate_Event  [0..*]  Data relating to a Candidate Assessment Event.   
Inline_Assessment_Data  Inline_Assessment_Data  [0..*]  The data used to create or modify a Candidate Assessment   
top
 

Assess_Candidate_Event

part of: Assess_Candidate_Response_Data
Data relating to a Candidate Assessment Event.
 
Parameter name Type/Value Cardinality Description Validations
Event_Reference  Unique_IdentifierObject  [0..1]  The Candidate Assessment retrieved will be the one associated with this Candidate Assessment Event.   
Job_Application_Reference  Job_ApplicationObject  [0..1]  The Candidate Assessment retrieved will be the one associated with this Job Application.   
Candidate_Reference  CandidateObject  [0..1]  The Candidate Assessments retrieved will be those associated with this Candidate.   
Job_Requisition_Reference  Job_Requisition_EnabledObject  [0..1]  The Candidate Assessments retrieved will be those associated with the Candidate for this Job Requisition.   
Job_Application_Event_Reference  Unique_IdentifierObject  [0..1]  The Candidate Assessment retrieved will be the one associated with this Job Application Event.   
Candidate_Assessment_Data  Recruiting_Assessment_Data  [0..1]  The data used to create or modify a Candidate Assessment.   
top
 

Recruiting_Assessment_Data

part of: Assess_Candidate_Event, Inline_Assessment_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
 

WorkerObject

part of: 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
 

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
 

Inline_Assessment_Data

part of: Assess_Candidate_Response_Data
The data used to create or modify a Candidate Assessment
 
Parameter name Type/Value Cardinality Description Validations
Job_Application_Reference  Job_ApplicationObject  [0..1]  The Candidate Assessment retrieved will be the one associated with this Job Application.   
Candidate_Reference  CandidateObject  [0..1]  The Candidate Assessments retrieved will be those associated with this Candidate.   
Job_Requisition_Reference  Job_Requisition_EnabledObject  [0..1]  The Candidate Assessments retrieved will be those associated with the Candidate for this Job Requisition.   
Job_Application_Event_Reference  Unique_IdentifierObject  [0..1]  The Candidate Assessment retrieved will be the one associated with this Job Application Event.   
Candidate_Assessment_Data  Recruiting_Assessment_Data  [0..1]  The data used to create or modify a Candidate Assessment.   
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Recruiting_AssessmentReferenceEnumeration

part of: Recruiting_AssessmentObjectID
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
 

WorkerReferenceEnumeration

part of: WorkerObjectID
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