Service Directory > v31.2 > Admissions > Get_Student_Application_Requirement_Assignments
 

Operation: Get_Student_Application_Requirement_Assignments

Retrieves Student Application Requirement Assignments by reference. For the Request Criteria, ALL three of the fields, Academic Person, Engagement Action Item, and Engagement Action Item Assignable MUST be entered in order to generate a response. Leaving out one of the fields or providing an incorrect combination of the three fields will result in an EMPTY response. Please make sure you have the correct Reference IDs when using the Request Criteria.


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

The Student Application Requirement Assignments request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Engagement_Action_Item_Assignment_Request_References  [0..1]  The references to the Engagement Action Item request   
Request_Criteria [Choice]   Engagement_Action_Item_Assignment_Request_Criteria  [0..1]  Specific criteria for specifying a Engagement Action Item 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. 
 
top
 

Response Element: Get_Student_Application_Requirement_Assignments_Response

The response for the Student Application Requirement Assignments Response get request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Engagement_Action_Item_Assignment_Request_References  [0..1]  The references to the Engagement Action Item request   
Request_Criteria  Engagement_Action_Item_Assignment_Request_Criteria  [0..1]  Specific criteria that can be used to return certain Engagement Action Items   
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  Engagement_Action_Item_Assignment_Response_Data  [0..1]  The data for the Engagement Action Item get request's response   
top
 

Engagement_Action_Item_Assignment_Request_References

part of: Get_Student_Application_Requirement_Assignments_Request, Get_Student_Application_Requirement_Assignments_Response
The Engagement Action Item Request References
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Action_Item_Assignment_Reference  Student_Application_Action_Item_AssignmentObject  [0..*]  The Engagement Action Items to be requested   
top
 

Student_Application_Action_Item_AssignmentObject

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

Student_Application_Action_Item_AssignmentObjectID

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

Engagement_Action_Item_Assignment_Request_Criteria

part of: Get_Student_Application_Requirement_Assignments_Request, Get_Student_Application_Requirement_Assignments_Response
Contains criteria for specifying which Engagement Action Item to return
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Action_Item_Reference  Application_Action_ItemObject  [0..1]  Specific Engagement Action Item Reference to return an Engagement Action Item Assignment   
Student_Reference  StudentObject  [0..1]  Specific Student Reference to return an Engagement Action Item Assignment   
Engagement_Action_Item_Assignable_Reference  Engagement_Action_Item_AssignableObject  [0..1]  Specific Engagement Action Item Assignable Reference to return an Engagement Action Item Assignment   
top
 

Application_Action_ItemObject

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

Application_Action_ItemObjectID

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

StudentObject

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

StudentObjectID

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

Engagement_Action_Item_AssignableObject

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

Engagement_Action_Item_AssignableObjectID

part of: Engagement_Action_Item_AssignableObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Legacy_Student_Award_ID, Receivable_Contract_Line_Reference_ID, Student_Aid_ID, Student_Application_ID, Student_Award_ID, Student_Sponsor_Contract_Line_ID, Student_Waiver_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_Student_Application_Requirement_Assignments_Request, Get_Student_Application_Requirement_Assignments_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_Requirement_Assignments_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
 

Engagement_Action_Item_Assignment_Response_Data

part of: Get_Student_Application_Requirement_Assignments_Response
The data for the Engagement Action Item get request's response
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Action_Item_Assignment  Engagement_Action_Item_Assignment  [0..*]  The Engagement Action Item(s)   
top
 

Engagement_Action_Item_Assignment

part of: Engagement_Action_Item_Assignment_Response_Data
The Engagement Action Item(s)
 
Parameter name Type/Value Cardinality Description Validations
Engagement_Action_Item_Assignment_Reference  Student_Application_Action_Item_AssignmentObject  [0..1]  The Engagement Action Item   
Engagement_Action_Item_Assignment_Data  Engagement_Action_Item_Assignment_Data  [0..*]  Related information for the Engagement Action Item 
Validation Description
The Reference ID or the Reference to the existing Engagement Action Item is incorrect, no such Instance exists.   
A Completed Engagement Action Item Assignment cannot be waived.   
The Engagement Action Item Assignment Status must equal "Waived", for an Engagement Action Item to be waived.   
A Completed Engagement Action Item Assignment cannot be waived.   
You can’t set a Completed or Waived action item to Returned when the action item has autocomplete criteria or an impact of Decision when the file status is Complete.   
The Completion Date should be specified to complete the Action Item   
The Completion Date should only be specified when completing the Action Item   
The Completion Date should be on or before today's date.   
The Completion Date should be on or after the Assigned Date of the Assignment.   
An Attachment can be uploaded only if the Action Item Assignment is being Completed or Waived.   
Only a Completed or Waived Action Item Assignment can be Requested.   
You cannot edit a Canceled Action Item Assignment, or set the Status of an Action Item Assignment to Canceled.   
 
top
 

Engagement_Action_Item_Assignment_Data

part of: Engagement_Action_Item_Assignment
The information about a Engagement Action Item
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Engagement Action Item Assignment Reference ID   
Engagement_Action_Item_Reference  Application_Action_ItemObject  [1..1]  The Engagement Action Item Reference for the Engagement Action Item   
Student_Reference  StudentObject  [1..1]  The Student for whom the Engagement Action Item is for   
Engagement_Action_Item_Assignable_Reference  Engagement_Action_Item_AssignableObject  [1..1]  The Engagement Action Item Assignable for the Engagement Action Item Assignment   
Assignment_Status_Reference  Engagement_Action_Item_Assignment_StatusObject  [1..1]  The Status of an Engagement Action Item Assignment   
Completion_Date  date  [0..1]  The Completion Date of the Assignment   
Engagement_Action_Item_Waiver_Reason_Reference  Engagement_Action_Item_Waiver_ReasonObject  [0..1]  The Engagement Action Item Waiver Reason for the Engagement Action Item Assignment   
Engagement_Action_Item_Notes  string  [0..1]  Engagement Action Item Waiver Reason Notes   
External_URL_Data  External_URL_for_Action_Item_Data  [0..*]  Personal URL associated with the Assignment 
Validation Description
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
Enter a unique External URL.   
 
Student_Attachment_Data  Student_Attachment_Drag_and_Drop_Data  [0..*]  Attachment associated with the Action Item Assignment   
Validation Description
The Reference ID or the Reference to the existing Engagement Action Item is incorrect, no such Instance exists.   
A Completed Engagement Action Item Assignment cannot be waived.   
The Engagement Action Item Assignment Status must equal "Waived", for an Engagement Action Item to be waived.   
A Completed Engagement Action Item Assignment cannot be waived.   
You can’t set a Completed or Waived action item to Returned when the action item has autocomplete criteria or an impact of Decision when the file status is Complete.   
The Completion Date should be specified to complete the Action Item   
The Completion Date should only be specified when completing the Action Item   
The Completion Date should be on or before today's date.   
The Completion Date should be on or after the Assigned Date of the Assignment.   
An Attachment can be uploaded only if the Action Item Assignment is being Completed or Waived.   
Only a Completed or Waived Action Item Assignment can be Requested.   
You cannot edit a Canceled Action Item Assignment, or set the Status of an Action Item Assignment to Canceled.   
top
 

Engagement_Action_Item_Assignment_StatusObject

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

Engagement_Action_Item_Assignment_StatusObjectID

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

Engagement_Action_Item_Waiver_ReasonObject

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

Engagement_Action_Item_Waiver_ReasonObjectID

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

External_URL_for_Action_Item_Data

part of: Engagement_Action_Item_Assignment_Data
The Information about an External URL for Action Item
 
Parameter name Type/Value Cardinality Description Validations
URL  string  [1..1]  The URL text for the External URL   
URL_Name  string  [0..1]  The Display Name for the URL   
Validation Description
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
Enter a unique External URL.   
top
 

Student_Attachment_Drag_and_Drop_Data

part of: Engagement_Action_Item_Assignment_Data
Wrapper element for Student Attachments
 
Parameter name Type/Value Cardinality Description Validations
Student_Attachment_Reference  Student_AttachmentObject  [0..1]  The instance of the Student Attachment.   
Attachments  Attachment_WWS_Data  [0..*]  Attachment WWS Data element that provides the attachment functionality   
top
 

Student_AttachmentObject

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

Student_AttachmentObjectID

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

Attachment_WWS_Data

part of: Student_Attachment_Drag_and_Drop_Data
Attachment WWS Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Text attribute identifying a unique ID for Attachment.   
Filename  string (255)   [1..1]  Filename for the attachment.   
File_Content  base64Binary  [1..1]  File content in binary format.   
Mime_Type_Reference  Mime_TypeObject  [0..1]  Mime Type Reference   
Comment  string  [0..1]  Comment   
top
 

Mime_TypeObject

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

Mime_TypeObjectID

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

Student_Application_Action_Item_AssignmentReferenceEnumeration

part of: Student_Application_Action_Item_AssignmentObjectID
Base Type
string
top
 

Application_Action_ItemReferenceEnumeration

part of: Application_Action_ItemObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Engagement_Action_Item_AssignableReferenceEnumeration

part of: Engagement_Action_Item_AssignableObjectID
Base Type
string
top
 

Engagement_Action_Item_Assignment_StatusReferenceEnumeration

part of: Engagement_Action_Item_Assignment_StatusObjectID
Base Type
string
top
 

Engagement_Action_Item_Waiver_ReasonReferenceEnumeration

part of: Engagement_Action_Item_Waiver_ReasonObjectID
Base Type
string
top
 

Student_AttachmentReferenceEnumeration

part of: Student_AttachmentObjectID
Base Type
string
top
 

Mime_TypeReferenceEnumeration

part of: Mime_TypeObjectID
Base Type
string
top