Service Directory > v25.1 > Financial_Aid > Put_Student_Award_Item
 

Operation: Put_Student_Award_Item

Creates a new Student Award Item (or updates an existing Student Award Item) with the information supplied in the request.


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

Wrapper element for the Put Student Award Item returned data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Student_Award_Item_Reference  Student_Award_ItemObject  [0..1]  Student Award Item Reference   
Student_Award_Item_Data  Student_Award_Item_Data  [1..1]  Wrapper element for Student Award Item Data 
Validation Description
A unique Student Award Item name is required.   
 
Validation Description
The Web Service is set to Add Only; but the Student Award Item already exists.   
top
 

Response Element: Put_Student_Award_Item_Response

Response for the Put Student Award Item Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Award_Item_Reference  Student_Award_ItemObject  [0..1]  Response for Put Student Charge Item Request   
top
 

Student_Award_ItemObject

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

Student_Award_ItemObjectID

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

Student_Award_Item_Data

part of: Put_Student_Award_Item_Request
Wrapper element for Student Award Item Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Student Award Item   
Effective_Date  date  [1..1]  Search for a Student Award Item using the Effective as of Date.   
Name  string  [1..1]  Search for a Student Award Item using the Name. The match must be an exact match with a Student Award Item Name that contains the Name specified.   
Type_Reference  Student_Award_TypeObject  [1..1]  Student Award Item Student Award Type   
Source_Reference  Student_Award_SourceObject  [1..1]  Student Award Item Student Award Source   
Need_Method_Reference  Student_Award_Need_MethodObject  [1..1]  Student Award Item Need Method   
Validation Description
A unique Student Award Item name is required.   
top
 

Student_Award_TypeObject

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

Student_Award_TypeObjectID

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

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

Student_Award_SourceObjectID

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

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

Student_Award_Need_MethodObjectID

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

part of: Student_Award_ItemObjectID
Base Type
string
top
 

Student_Award_TypeReferenceEnumeration

part of: Student_Award_TypeObjectID
Base Type
string
top
 

Student_Award_SourceReferenceEnumeration

part of: Student_Award_SourceObjectID
Base Type
string
top
 

Student_Award_Need_MethodReferenceEnumeration

part of: Student_Award_Need_MethodObjectID
Base Type
string
top