Service Directory > v32.1 > Financial_Aid > Put_Financial_Aid_ISIR_Note
 

Operation: Put_Financial_Aid_ISIR_Note

This Web Service Creates/Edits Financial Aid ISIR Notes


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

Put Student Financial Aid ISIR Note Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Financial_Aid_ISIR_Note_Reference  Student_Financial_Aid_ISIR_NoteObject  [0..1]  Financial Aid ISIR Note Reference   
Financial_Aid_ISIR_Note_Data  Financial_Aid_ISIR_Note_Data  [0..1]  Financial Aid ISIR Note Data 
Validation Description
Financial Aid ISIR Notes cannot be Public   
Financial Aid Award Year cannot be edited for Financial Aid ISIR Note   
The Academic Period must be valid for the selected Student's Attendance Plan.   
Academic Periods can only be submitted if a Student has an Attendance Plan   
 
Validation Description
The Web Service is set to Add Only but the Student Financial Aid ISIR Note already exists.   
top
 

Response Element: Put_Financial_Aid_ISIR_Note_Response

Put Student Financial Aid ISIR Note Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Financial_Aid_ISIR_Note_Reference  Student_Financial_Aid_ISIR_NoteObject  [0..1]  Student Financial Aid ISIR Note Reference   
top
 

Student_Financial_Aid_ISIR_NoteObject

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

Student_Financial_Aid_ISIR_NoteObjectID

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

Financial_Aid_ISIR_Note_Data

part of: Put_Financial_Aid_ISIR_Note_Request
Student Financial Aid ISIR Note Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID   
Student_Reference  StudentObject  [1..1]  Student for Student Note 
Validation Description
The Student cannot be edited on a Student Financial Aid ISIR Note.   
 
Financial_Aid_Award_Year_Reference  Financial_Aid_Award_YearObject  [1..1]  Academic Year for Student Note   
Academic_Period_Reference  Academic_PeriodObject  [0..1]  Academic Period for the Student's Attendance Plan   
Student_Note_Data  Student_Note_Data  [0..1]  Student Note Data   
Validation Description
Financial Aid ISIR Notes cannot be Public   
Financial Aid Award Year cannot be edited for Financial Aid ISIR Note   
The Academic Period must be valid for the selected Student's Attendance Plan.   
Academic Periods can only be submitted if a Student has an Attendance Plan   
top
 

StudentObject

part of: Financial_Aid_ISIR_Note_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
 

Financial_Aid_Award_YearObject

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

Financial_Aid_Award_YearObjectID

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

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

Academic_PeriodObjectID

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

part of: Financial_Aid_ISIR_Note_Data
Student Note Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Note_Topic_Reference  Student_Note_Topic__Mixed_Object  [0..*]  Engagement Conversation Topic Reference   
Student_Note_Type_Reference  Student_Note_TypeObject  [0..1]  Student Note Type Reference   
Student_Note_Date  dateTime  [1..1]  Student Note Date   
Public  boolean  [0..1]  Public   
Note  RichText  [1..1]  The content for the Student Note   
top
 

Student_Note_Topic__Mixed_Object

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

Student_Note_Topic__Mixed_ObjectID

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

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

Student_Note_TypeObjectID

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

part of: Student_Financial_Aid_ISIR_NoteObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Financial_Aid_Award_YearReferenceEnumeration

part of: Financial_Aid_Award_YearObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Student_Note_Topic__Mixed_ReferenceEnumeration

part of: Student_Note_Topic__Mixed_ObjectID
Base Type
string
top
 

Student_Note_TypeReferenceEnumeration

part of: Student_Note_TypeObjectID
Base Type
string
top
 

RichText

part of: Student_Note_Data
Base Type
string
top