Service Directory > v31.2 > Recruiting > Get_Interviews
 

Operation: Get_Interviews

Retrieves Interview Data for the Schedule Interview task.


@ - 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_Interviews_Request

Contains request reference, criteria, filter and response group for getting interview data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Interview_Request_References  [0..1]  Wrapper element containing references to a specific interview.   
Request_Criteria [Choice]   Interview_Request_Criteria  [0..1]  Criteria used to determine which interview to return.   
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_Group  Interview_Response_Group  [0..1]  Element containing Interview response group options.   
top
 

Response Element: Get_Interviews_Response

Wrapper element containing Interview Response Data for requested references or criteria and for requested response group.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Interview_Request_References  [0..1]  Contains the interview reference.   
Request_Criteria  Interview_Request_Criteria  [0..1]  Criteria used to determine which interview to return.   
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_Group  Interview_Response_Group  [0..1]  Element containing Interview response group options.   
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  Interview_Response_Data  [0..1]  Contains interview data.   
top
 

Interview_Request_References

part of: Get_Interviews_Request, Get_Interviews_Response
Contains the interview reference.
 
Parameter name Type/Value Cardinality Description Validations
Interview_Reference  Unique_IdentifierObject  [1..*]  Interview Request Reference.   
top
 

Unique_IdentifierObject

part of: Interview_Data, Interview_Session_Data, Interview_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  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
 

Interview_Request_Criteria

part of: Get_Interviews_Request, Get_Interviews_Response
Criteria used to determine which interview to return.
 
Parameter name Type/Value Cardinality Description Validations
Job_Application_Reference [Choice]   Job_ApplicationObject  [1..1]  A reference to the Job Application associated to the interview.   
Candidate_Interview_Criteria_Data [Choice]   Move_Candidate_Criteria  [1..1]  A Candidate and Job Requisition reference associated with the interview.   
top
 

Job_ApplicationObject

part of: Interview_Data, Interview_Request_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_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: Interview_Data, Interview_Request_Criteria
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.   
Job_Requisition_Reference  Job_Requisition_EnabledObject  [1..1]  A reference to a Job 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
 

Response_Filter

part of: Get_Interviews_Request, Get_Interviews_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
 

Interview_Response_Group

part of: Get_Interviews_Request, Get_Interviews_Response
Element containing Interview response group options.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean flag to include Reference in response.   
top
 

Response_Results

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

Interview_Response_Data

part of: Get_Interviews_Response
Contains interview data.
 
Parameter name Type/Value Cardinality Description Validations
Interview  Interview  [0..*]  Contains interview data.   
top
 

Interview

part of: Interview_Response_Data
Contains interview data.
 
Parameter name Type/Value Cardinality Description Validations
Interview_Data  Interview_Data  [0..*]  Contains one of the following: Interview Event Reference, Job Application Reference, or the Candidate Interview Criteria Data. 
Validation Description
The Interview Event must be In Progress to create an Interview Team.   
You aren't authorized to schedule an interview for this job application because the interview event isn't awaiting your action.   
You aren't authorized to schedule an interview for this candidate and job requisition because the interview event isn't awaiting your action.   
 
top
 

Interview_Data

part of: Interview
Contains one of the following: Interview Event Reference, Job Application Reference, or the Candidate Interview Criteria Data.
 
Parameter name Type/Value Cardinality Description Validations
Interview_Event_Reference [Choice]   Unique_IdentifierObject  [1..1]  Reference to an interview event. 
Validation Description
You cannot schedule an interview that has been saved for later or is for a reactivated job application.   
 
Job_Application_Reference [Choice]   Job_ApplicationObject  [1..1]  A reference to the Job Application associated to the interview.   
Candidate_Interview_Criteria_Data [Choice]   Move_Candidate_Criteria  [1..1]  A Candidate and Job Requisition reference associated with the interview.   
Interview_Session_Data  Interview_Session_Data  [0..*]  Contains the interviewers, duration in minutes, interview start time, interview end time, interview type, and comment data.   
Overall_Comment  string  [0..1]  The overall comment for the interview team.   
Timezone_Reference  Time_ZoneObject  [1..1]  Time Zone for interview schedule   
Validation Description
The Interview Event must be In Progress to create an Interview Team.   
You aren't authorized to schedule an interview for this job application because the interview event isn't awaiting your action.   
You aren't authorized to schedule an interview for this candidate and job requisition because the interview event isn't awaiting your action.   
top
 

Interview_Session_Data

part of: Interview_Data
Contains the interview session reference and its data.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Indicates if the interview session reference will be deleted.   
Interview_Session_Reference  Unique_IdentifierObject  [0..1]  A reference to the interview session. 
Validation Description
Enter an Interview Session that belongs to this Interview Event.   
You can't delete interview sessions with one or more interviewers who have submitted feedback.   
 
Interview_Session_Details_Data  Interview_Session_Details_Data  [0..*]  Contains the interviewers, duration in minutes, interview start time, interview end time, interview type, and comment data. 
Validation Description
Enter an Interview End Time that is later than the Interview Start Time.   
Enter a location that matches a location type selected in the Location Types for Interview Scheduling prompt on the Edit Tenant Setup - Recruiting task.   
You can't enter a location because the Microsoft Outlook Interview Scheduling Integration check box on the Edit Tenant Setup - Recruiting task is selected.   
 
top
 

Interview_Session_Details_Data

part of: Interview_Session_Data
Contains the interviewers, duration in minutes, interview start time, interview end time, interview type, and comment data.
 
Parameter name Type/Value Cardinality Description Validations
Interviewers_Reference  WorkerObject  [1..*]  The interviewer on the interview team. 
Validation Description
You have deleted interviewers that have already submitted their feedback: [Interviewers who have submitted feedback]. Add these interviewers back to the interview session: [Interviewers who were removed].   
 
Interview_Start_Time  dateTime  [1..1]  The start day and time of the interview.   
Interview_End_Time  dateTime  [1..1]  The end day and time of the interview.   
Interview_Location_Reference  LocationObject  [0..1]  The location of the interview session.   
Interview_Type_Reference  Interview_TypeObject  [0..1]  The type of interview the interview session will be.   
Interview_Competencies_Reference  CompetencyObject  [0..*]  The competencies an interviewer should evaluate the candidate on. 
Validation Description
Feedback has already been submitted for the competencies you are removing: [removed competencies]   
 
Interview_Questionnaires_Reference  QuestionnaireObject  [0..*]  The questionnaires an interviewer should evaluate for an interview session. 
Validation Description
Feedback has already been submitted for the questionnaires you are removing: [removed questionnaires]   
 
Comment  string  [0..1]  Comment for the interviewers on the interview session.   
Validation Description
Enter an Interview End Time that is later than the Interview Start Time.   
Enter a location that matches a location type selected in the Location Types for Interview Scheduling prompt on the Edit Tenant Setup - Recruiting task.   
You can't enter a location because the Microsoft Outlook Interview Scheduling Integration check box on the Edit Tenant Setup - Recruiting task is selected.   
top
 

WorkerObject

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

LocationObject

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

LocationObjectID

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

Interview_TypeObject

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

Interview_TypeObjectID

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

CompetencyObject

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

CompetencyObjectID

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

QuestionnaireObject

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

QuestionnaireObjectID

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

Time_ZoneObject

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

Time_ZoneObjectID

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

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
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Interview_TypeReferenceEnumeration

part of: Interview_TypeObjectID
Base Type
string
top
 

CompetencyReferenceEnumeration

part of: CompetencyObjectID
Base Type
string
top
 

QuestionnaireReferenceEnumeration

part of: QuestionnaireObjectID
Base Type
string
top
 

Time_ZoneReferenceEnumeration

part of: Time_ZoneObjectID
Base Type
string
top