Service Directory > v31.2 > Financial_Aid > Put_Student_Preliminary_Award
 

Operation: Put_Student_Preliminary_Award

Creates a new Student Preliminary Award (or updates an existing Student Preliminary Award) 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_Preliminary_Award_Request

Element Container for Put Student Preliminary Award Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only for Student Preliminary Award   
Student_Preliminary_Award_Reference  Student_Preliminary_AwardObject  [0..1]  This Student Preliminary Award   
Student_Preliminary_Award_Data  Student_Preliminary_Award_Data  [0..1]  Element Container for Student Preliminary Award Data   
Validation Description
The web service is set to add only, but the Student Preliminary Award already exists.   
top
 

Response Element: Put_Student_Preliminary_Award_Response

Element Container for Put Student Preliminary Award Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Preliminary_Award_Reference  Student_Preliminary_AwardObject  [0..1]  This Student Preliminary Award   
top
 

Student_Preliminary_AwardObject

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

Student_Preliminary_AwardObjectID

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

part of: Put_Student_Preliminary_Award_Request
Element Container for Student Preliminary Award Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID for Student Preliminary Award   
Student_Prospect_Recruitment_Reference  Student_RecruitmentObject  [0..1]  The Student Recruitment that owns the Student Preliminary Award   
Student_Preliminary_Award_Date  dateTime  [1..1]  Student Preliminary Award Date for Student Preliminary Award.   
Academic_Period_Reference  Academic_Period_AbstractObject  [1..1]  Academic Period for Student Preliminary Award   
Student_Award_Item_Reference  Student_Award_ItemObject  [1..1]  Student Award Item for Student Preliminary Award   
Student_Preliminary_Award_Amount  decimal (14, 2) >0   [1..1]  Student Preliminary Award Amount for Student Preliminary Award   
Student_Preliminary_Official_Award  boolean  [0..1]  Student Preliminary Official Award for Student Preliminary Award   
top
 

Student_RecruitmentObject

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

Student_RecruitmentObjectID

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

Academic_Period_AbstractObject

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

Academic_Period_AbstractObjectID

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

part of: Student_Preliminary_Award_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_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_Preliminary_AwardReferenceEnumeration

part of: Student_Preliminary_AwardObjectID
Base Type
string
top
 

Student_RecruitmentReferenceEnumeration

part of: Student_RecruitmentObjectID
Base Type
string
top
 

Academic_Period_AbstractReferenceEnumeration

part of: Academic_Period_AbstractObjectID
Base Type
string
top
 

Student_Award_ItemReferenceEnumeration

part of: Student_Award_ItemObjectID
Base Type
string
top