Service Directory > v31.2 > Student_Finance > Put_Student_Financial_Account_Note
 

Operation: Put_Student_Financial_Account_Note

Task that allows creation of Student Financial Account Note through Web Service


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

Put Request for Student Financial Account Note
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Student_Financial_Account_Note_Reference  Student_Financial_Account_NoteObject  [0..1]  Reference for Student Financial Account Note   
Student_Financial_Account_Note_Data  Student_Financial_Account_Note_Data  [1..1]  Data for Student Financial Account Note 
Validation Description
Academic Period is not valid for the Student.   
Topic must be a Student Financial Account Note Topic   
Student Financial Account Note cannot be Public   
 
Validation Description
The web service is set to add only, but the Student Financial Account Note already exists   
top
 

Response Element: Put_Student_Financial_Account_Note_Response

Response Element for Put Task
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Financial_Account_Note_Reference  Student_Financial_Account_NoteObject  [0..1]  Student Financial Account Note that is created with Put task   
top
 

Student_Financial_Account_NoteObject

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

Student_Financial_Account_NoteObjectID

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

Student_Financial_Account_Note_Data

part of: Put_Student_Financial_Account_Note_Request
Data Element for Put Request
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Get Note data Task   
Student_Reference  StudentObject  [1..1]  Student in Note   
Academic_Period_Reference  Academic_PeriodObject  [0..1]  Academic Period in Note   
Student_Note_Data_Reference  Student_Note_Data  [0..*]  Rest of inherited student note data   
Validation Description
Academic Period is not valid for the Student.   
Topic must be a Student Financial Account Note Topic   
Student Financial Account Note cannot be Public   
top
 

StudentObject

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

Academic_PeriodObject

part of: Student_Financial_Account_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: Student_Financial_Account_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_Account_NoteReferenceEnumeration

part of: Student_Financial_Account_NoteObjectID
Base Type
string
top
 

StudentReferenceEnumeration

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