Service Directory > v32.1 > Recruiting > Move_Candidate
 

Operation: Move_Candidate

Move Candidate from any Recruiting Stage to next possible stage or to a disposition stage.


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

A request to move a Candidate from a stage to next possible stage or to a disposition stage.
 
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.   
 
Move_Candidate_Data  Move_Candidate_Data  [1..1]  Reference to the Candidate Job Application to be moved from a stage to next possible stage or to a disposition stage. 
Validation Description
The Business Process must be in progress to move candidate to the next stage.   
The provided Candidate and Requisition does not have precisely one Job Application Event in progress.   
 
top
 

Response Element: Move_Candidate_Response

The result of an attempt to move a Candidate from a stage to next possible stage or to a disposition stage.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Event_Reference  Recruiting_EventObject  [0..1]  A reference to the Job Application Event that has been moved to the requested stage.   
top
 

Dynamic_Business_Process_Parameters

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

Move_Candidate_Data

part of: Move_Candidate_Request
Reference to the Candidate Job Application to be moved from a stage to next possible stage or to a disposition stage.
 
Parameter name Type/Value Cardinality Description Validations
Event_Reference [Choice]   Unique_IdentifierObject  [1..1]  A reference to the Job Application event.   
Job_Application_Reference [Choice]   Job_ApplicationObject  [1..1]  A reference to the Job Application to be moved from a stage to next possible stage or to a disposition stage.   
Candidate_Criteria_Data [Choice]   Move_Candidate_Criteria  [1..1]  Collects the Candidate reference and Job Requisition reference   
Validation Description
The Business Process must be in progress to move candidate to the next stage.   
The provided Candidate and Requisition does not have precisely one Job Application Event in progress.   
top
 

Unique_IdentifierObject

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

Move_Candidate_Criteria

part of: Move_Candidate_Data
Collects the Candidate reference and Job Requisition reference
 
Parameter name Type/Value Cardinality Description Validations
Candidate_Reference  CandidateObject  [1..1]  A reference to the Candidate.   
Requisition_Reference  Job_Requisition_EnabledObject  [1..1]  A reference to a Requisition   
top
 

CandidateObject

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

part of: Move_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_EventObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Recruiting_EventObjectID

part of: Recruiting_EventObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Background_Check_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_EventReferenceEnumeration

part of: Recruiting_EventObjectID
Base Type
string
top