Service Directory > v32.1 > Student_Records > Put_Academic_Record_Note
 

Operation: Put_Academic_Record_Note

Creates a new Academic Record Note (or updates an existing Academic Record Note) 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_Academic_Record_Note_Request

Put Request for Academic Record Note
 
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.   
Academic_Record_Note_Reference  Academic_Record_NoteObject  [0..1]  The reference to the Academic Record Note being updated. For new Academic Record Notes, this element will not exist.   
Academic_Record_Note_Data  Academic_Record_Note_Data  [1..1]  Contains data for Academic Record Note 
Validation Description
Submit either Student Reference or Academic Record Reference.   
Student has more than one Academic Record. Please submit Academic Record Reference. If using a version prior to v30.0, please update to the latest version.   
Student Note Topics for Academic Record Notes must include Academic Records Category.   
Public attribute cannot be edited on an Academic Record Note.   
Student cannot be edited for Academic Record Note.   
Academic Record Reference must be for the Student associated with the Academic Record Note being edited.   
This task can only be used to create or edit Public and Private Academic Record Notes. Check to make sure the referenced note is not a Private or Public Recruiting, Admissions, or Advising note.   
 
Validation Description
The web service is set to add only, but the Academic Record Note already exists.   
top
 

Response Element: Put_Academic_Record_Note_Response

Response Element for Put Task
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Academic_Record_Note_Reference  Academic_Record_NoteObject  [0..1]  Academic Record Note that is created with Put task   
top
 

Academic_Record_NoteObject

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

Academic_Record_NoteObjectID

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

Academic_Record_Note_Data

part of: Put_Academic_Record_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  [0..1]  Student in Note   
Academic_Record_Reference  Academic_RecordObject  [0..1]  Academic Period in Note   
Student_Note_Data_Reference  Student_Note_Data  [1..1]  Rest of inherited Student Note data   
Validation Description
Submit either Student Reference or Academic Record Reference.   
Student has more than one Academic Record. Please submit Academic Record Reference. If using a version prior to v30.0, please update to the latest version.   
Student Note Topics for Academic Record Notes must include Academic Records Category.   
Public attribute cannot be edited on an Academic Record Note.   
Student cannot be edited for Academic Record Note.   
Academic Record Reference must be for the Student associated with the Academic Record Note being edited.   
This task can only be used to create or edit Public and Private Academic Record Notes. Check to make sure the referenced note is not a Private or Public Recruiting, Admissions, or Advising note.   
top
 

StudentObject

part of: Academic_Record_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_RecordObject

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

Academic_RecordObjectID

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

Academic_Record_NoteReferenceEnumeration

part of: Academic_Record_NoteObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_RecordReferenceEnumeration

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