Service Directory > v31.2 > Student_Records > Get_Academic_Record_Notes
 

Operation: Get_Academic_Record_Notes

Returns information for Academic Record Notes based on Request Criteria. If the request does not specify an Academic Record Note, this operation returns information for all Academic Record 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: Get_Academic_Record_Notes_Request

Get Academic Record Note Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Academic_Record_Note_Request_References  [0..1]  Element containing the list of Academic Record Note(s) for which data is requested.   
Request_Criteria [Choice]   Academic_Record_Note_Request_Criteria  [0..1]  Element to specify criteria options to search for Academic Record Notes within the Workday system. Search by Student   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Academic_Record_Notes_Response

Response for Get Academic Record Notes
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Academic_Record_Note_Request_References  [0..1]  Request References for the Get Academic Record Note Web Service   
Request_Criteria  Academic_Record_Note_Request_Criteria  [0..1]  Request Criteria for the Get Academic Record Note Web Service   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Academic_Record_Note_Response_Data  [0..1]  Response Data for Get Academic Record Note   
top
 

Academic_Record_Note_Request_References

part of: Get_Academic_Record_Notes_Response, Get_Academic_Record_Notes_Request
Request References for the Get Academic Record Note Web Service
 
Parameter name Type/Value Cardinality Description Validations
Academic_Record_Note_Reference  Academic_Record_NoteObject  [1..*]  Academic Record Notes to return in the Get Academic Record Note Web Service   
top
 

Academic_Record_NoteObject

part of: Academic_Record_Note, Academic_Record_Note_Request_References
 
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_Request_Criteria

part of: Get_Academic_Record_Notes_Response, Get_Academic_Record_Notes_Request
Request Criteria for the Get Academic Record Note Web Service
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..*]  Students whose notes will be returned in the Get Academic Record Note Web Service   
top
 

StudentObject

part of: Academic_Record_Note_Data, Academic_Record_Note_Request_Criteria
 
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
 

Response_Filter

part of: Get_Academic_Record_Notes_Response, Get_Academic_Record_Notes_Request
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Academic_Record_Notes_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Academic_Record_Note_Response_Data

part of: Get_Academic_Record_Notes_Response
Response for Get Academic Record Note
 
Parameter name Type/Value Cardinality Description Validations
Academic_Record_Note  Academic_Record_Note  [0..*]  Response Data for Academic Record Note   
top
 

Academic_Record_Note

part of: Academic_Record_Note_Response_Data
Response Data for Academic Record Note
 
Parameter name Type/Value Cardinality Description Validations
Academic_Record_Note_Reference  Academic_Record_NoteObject  [0..1]  Academic Record Note Reference for Academic Record Note Web Service   
Academic_Record_Note_Data  Academic_Record_Note_Data  [0..*]  Academic Record Data Element for Academic Record Note Web Service 
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
 

Academic_Record_Note_Data

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

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