Service Directory > v25.1 > Admissions > Put_Student_Application_Requirement_Assignment
 

Operation: Put_Student_Application_Requirement_Assignment

Updates instance of Student Application Requirement Assignment using the information provided in the request. This task only completes existing Student Application Requirement Assignments, it does not create them. The element content Academic Person, Engagement Action Item Assignable, and Engagement Action Item are not enterable. Entering data in these fields will not persist over or change the existing values.


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

Put Student Application Requirement Assignments
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Engagement_Action_Item_Assignment_Reference  Engagement_Action_Item_AssignmentObject  [0..1]  The reference to the Engagement Action Item being updated.   
Engagement_Action_Item_Assignment_Data  Engagement_Action_Item_Assignment_Data  [1..1]  Contains data about the Engagement Action Item 
Validation Description
The Engagement Action Item is already Complete, you cannot Incomplete a Complete Engagement Action item.   
The Reference ID or the Reference to the existing Engagement Action Item is incorrect, no such Instance exists.   
The Engagement Action Item Assignment Completed field must be True for an Engagement Action Item to be waived.   
A Completed Engagement Action Item Assignment cannot be waived.   
 
top
 

Response Element: Put_Student_Application_Requirement_Assignment_Response

Wrapper element for the Put Student Application Requirement Assignment returned data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Engagement_Action_Item_Assignment_Reference  Engagement_Action_Item_AssignmentObject  [0..1]  The reference to the Engagement Action Item which was updated   
top
 

Engagement_Action_Item_AssignmentObject

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

Engagement_Action_Item_AssignmentObjectID

part of: Engagement_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_Data

part of: Put_Student_Application_Requirement_Assignment_Request
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  Engagement_Action_ItemObject  [1..1]  The Engagement Action Item Reference for the Engagement Action Item   
Academic_Person_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   
Engagement_Action_Item_Complete  boolean  [0..1]  The flag to mark if the Engagement Action Item Assignment is complete or not   
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_Waiver_Reason_Notes  string  [0..1]  Engagement Action Item Waiver Reason Notes   
Validation Description
The Engagement Action Item is already Complete, you cannot Incomplete a Complete Engagement Action item.   
The Reference ID or the Reference to the existing Engagement Action Item is incorrect, no such Instance exists.   
The Engagement Action Item Assignment Completed field must be True for an Engagement Action Item to be waived.   
A Completed Engagement Action Item Assignment cannot be waived.   
top
 

Engagement_Action_ItemObject

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

Engagement_Action_ItemObjectID

part of: Engagement_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, Student_Assignment_Line_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
 
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
 
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, ISIR_Transaction_ID, 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
 

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
 

Engagement_Action_Item_AssignmentReferenceEnumeration

part of: Engagement_Action_Item_AssignmentObjectID
Base Type
string
top
 

Engagement_Action_ItemReferenceEnumeration

part of: Engagement_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_Waiver_ReasonReferenceEnumeration

part of: Engagement_Action_Item_Waiver_ReasonObjectID
Base Type
string
top