Service Directory > v31.2 > Recruiting > Get_Job_Application_Additional_Data
 

Operation: Get_Job_Application_Additional_Data

Get Additional data for Job Application


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

Contains request reference, criteria, filter and response group for getting Job Application Additional data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Job_Application_Request_References  [0..1]  Job Application Reference   
Request_Criteria [Choice]   Job_Application_Request_Criteria  [0..1]  Utilize the Request Criteria element to filter instance(s) of Job Application Additional Data by Candidate 
Validation Description
A Candidate Reference is required to find Job Applications Additional Data by request criteria.  A Candidate Reference is required to find Job Applications Additional Data by request criteria. 
 
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  Job_Application_Response_Group  [0..1]  Job Application Additional Data response group   
top
 

Response Element: Get_Job_Application_Additional_Data_Response

Wrapper element containing Candidate Job Application Additional 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  Job_Application_Request_References  [0..1]  Job Application Reference   
Request_Criteria  Job_Application_Request_Criteria  [0..1]  Utilize the Request Criteria element to filter instance(s) of Job Application Additional Data by Candidate 
Validation Description
A Candidate Reference is required to find Job Applications Additional Data by request criteria.  A Candidate Reference is required to find Job Applications Additional Data by request criteria. 
 
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  Job_Application_Response_Group  [0..1]  Job Application Additional Data response group   
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  Job_Application_Additional_Data_Response_Data  [0..1]  Contains Job Application Additional data   
top
 

Job_Application_Request_References

part of: Get_Job_Application_Additional_Data_Request, Get_Job_Application_Additional_Data_Response
Job Application Reference
 
Parameter name Type/Value Cardinality Description Validations
Job_Application_Reference  Job_ApplicationObject  [1..*]  Job Application Reference   
top
 

Job_ApplicationObject

part of: Job_Application_Request_References, Job_Application
 
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
 

Job_Application_Request_Criteria

part of: Get_Job_Application_Additional_Data_Request, Get_Job_Application_Additional_Data_Response
Utilize the Request Criteria element to filter instance(s) of Job Application Additional Data by Candidate
 
Parameter name Type/Value Cardinality Description Validations
Candidate_Reference  CandidateObject  [0..1]  Contains candidate references.   
Validation Description
A Candidate Reference is required to find Job Applications Additional Data by request criteria.  A Candidate Reference is required to find Job Applications Additional Data by request criteria. 
top
 

CandidateObject

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

Response_Filter

part of: Get_Job_Application_Additional_Data_Request, Get_Job_Application_Additional_Data_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
 

Job_Application_Response_Group

part of: Get_Job_Application_Additional_Data_Request, Get_Job_Application_Additional_Data_Response
Job Application Additional Data response group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Job_Application_Additional_Data_Response_Data

part of: Get_Job_Application_Additional_Data_Response
Contains Job Application Additional data
 
Parameter name Type/Value Cardinality Description Validations
Job_Application_Custom_Object_Data  Job_Application  [0..*]  Wrapper element containing Candidate Job Application Additional Data for requested references or criteria and for requested response group.   
top
 

Job_Application

part of: Job_Application_Additional_Data_Response_Data
Job Application Additional Data
 
Parameter name Type/Value Cardinality Description Validations
Job_Application_Reference  Job_ApplicationObject  [0..1]  Job Application Reference   
Business_Object_Additional_Data  Non_Effective_Dated_Web_Service_Additional_Data  [0..1]  Non Effective Dated Web Service Additional Data   
top
 

Non_Effective_Dated_Web_Service_Additional_Data

part of: Job_Application
Non Effective Dated Web Service Additional Data
 
Parameter name Type/Value Cardinality Description Validations
top
 

Job_ApplicationReferenceEnumeration

part of: Job_ApplicationObjectID
Base Type
string
top
 

CandidateReferenceEnumeration

part of: CandidateObjectID
Base Type
string
top