Service Directory > v31.2 > Admissions > Get_Student_Application_Admission_Responses
 

Operation: Get_Student_Application_Admission_Responses

The Web Service to retrieve Student Applications with Admission Responses.


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

Wrapper for data for the Request for Student Applications with Admission Resposnes
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Application_Admission_Response_Request_References  [0..1]  The references to the Student Applications to get   
Request_Criteria [Choice]   Student_Application_Admission_Response_Request_Criteria  [0..1]  The request criteria for Student Applications with Admission Reponses   
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_Student_Application_Admission_Responses_Response

The wrapper for the Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Application_Admission_Response_Request_References  [0..1]  The wrapper for references to Student Applications with Admission Responses   
Request_Criteria  Student_Application_Admission_Response_Request_Criteria  [0..1]  The request criteria for Student Applications with Admission Responses   
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  Student_Application_Admission_Response_Response_Data  [0..1]  The Response Data for a Student Applications with Admission Responses   
top
 

Student_Application_Admission_Response_Request_References

part of: Get_Student_Application_Admission_Responses_Request, Get_Student_Application_Admission_Responses_Response
The wrapper for references to Student Applications with Admission Responses
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_Admission_Response_Reference  Student_ApplicationObject  [1..*]  The reference to Student Applications with Admission Responses   
top
 

Student_ApplicationObject

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

Student_ApplicationObjectID

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

Student_Application_Admission_Response_Request_Criteria

part of: Get_Student_Application_Admission_Responses_Request, Get_Student_Application_Admission_Responses_Response
The request criteria for Student Applications with Admission Responses
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Application_Admission_Responses_Request, Get_Student_Application_Admission_Responses_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_Student_Application_Admission_Responses_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
 

Student_Application_Admission_Response_Response_Data

part of: Get_Student_Application_Admission_Responses_Response
The wrapper for the wrapper for the Student Applications with Admission Responses
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_Admission_Response  Student_Application_Admission_Response  [0..*]  The wrapper for Student Applications with Admission Responses   
top
 

Student_Application_Admission_Response

part of: Student_Application_Admission_Response_Response_Data
The Student Application and the associated Admission Response
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_Admission_Response_Reference  Student_ApplicationObject  [0..1]  The reference Student Application   
Student_Application_Admission_Response_Data  Student_Application_Admission_Response_Data  [0..1]  The element that contains the reference to the Student Application and the Admission Response 
Validation Description
Cannot use the Not Applicable Admission Response for Student Applications.   
 
top
 

Student_Application_Admission_Response_Data

part of: Student_Application_Admission_Response
The element that contains the reference to the Student Application and the Admission Response
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Reference ID of the Student Application   
Admission_Response_Reference  Student_Application_Admission_ResponseObject  [1..1]  The Admission Response for the Student Application   
Validation Description
Cannot use the Not Applicable Admission Response for Student Applications.   
top
 

Student_Application_Admission_ResponseObject

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

Student_Application_Admission_ResponseObjectID

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

Student_ApplicationReferenceEnumeration

part of: Student_ApplicationObjectID
Base Type
string
top
 

Student_Application_Admission_ResponseReferenceEnumeration

part of: Student_Application_Admission_ResponseObjectID
Base Type
string
top