Service Directory > v32.1 > Admissions > Get_Admissions_Notes
 

Operation: Get_Admissions_Notes

Retrieves Admissions Notes by reference.


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

Get Student Admissions Notes Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Admissions_Note_Request_References  [0..1]  Admissions Note Request References   
Request_Criteria [Choice]   Student_Admissions_Note_Request_Criteria  [0..1]  Get Student Admissions Note Request Criteria   
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_Admissions_Notes_Response

Get Student Admissions Notes Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Admissions_Note_Request_References  [0..1]  Student Admissions Note Request References   
Request_Criteria  Student_Admissions_Note_Request_Criteria  [0..1]  Student Admissions Note Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Student_Admissions_Note_Response_Data  [0..1]  Student Admissions Note Response Data   
top
 

Student_Admissions_Note_Request_References

part of: Get_Admissions_Notes_Request, Get_Admissions_Notes_Response
Admissions Note Request References
 
Parameter name Type/Value Cardinality Description Validations
Admissions_Note_Reference  Student_Recruiting__Admissions__and_Public_NoteObject  [1..*]  Student Admissions Note   
top
 

Student_Recruiting__Admissions__and_Public_NoteObject

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

Student_Recruiting__Admissions__and_Public_NoteObjectID

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

Student_Admissions_Note_Request_Criteria

part of: Get_Admissions_Notes_Request, Get_Admissions_Notes_Response
Get Student Admissions Note Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Admissions_Notes_Request, Get_Admissions_Notes_Response
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_Admissions_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
 

Student_Admissions_Note_Response_Data

part of: Get_Admissions_Notes_Response
Student Admissions Note Response Data
 
Parameter name Type/Value Cardinality Description Validations
Admissions_Note  Student_Admissions_Note  [0..*]  Student Admissions Note   
top
 

Student_Admissions_Note

part of: Student_Admissions_Note_Response_Data
Student Admissions Note
 
Parameter name Type/Value Cardinality Description Validations
Admissions_Note_Reference  Student_Recruiting__Admissions__and_Public_NoteObject  [0..1]  Student Admissions Note   
Admissions_Note_Data  Student_Admissions_Note_Data  [0..*]  Student Admissions Note Data 
Validation Description
The Category for a Student Note Topic for an Admissions Note must be Admissions, Recruiting + Admissions, or no category   
Student Notable cannot be edited for Student Admissions Note   
Invalid Student Note Type specified for Student Admissions Note   
Public Attribute cannot be edited on a Student Admissions Note   
Student Notable is not valid for Student   
 
top
 

Student_Admissions_Note_Data

part of: Student_Admissions_Note
Student Admissions Note Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID   
Student_Reference  StudentObject  [1..1]  Student Secured 
Validation Description
The Student cannot be edited on a Student Admissions Note.   
 
Student_Application_Reference  Student_NotableObject  [1..1]  Student Application Secured   
Student_Note_Data  Student_Note_Data  [0..1]  Student Note Data   
Validation Description
The Category for a Student Note Topic for an Admissions Note must be Admissions, Recruiting + Admissions, or no category   
Student Notable cannot be edited for Student Admissions Note   
Invalid Student Note Type specified for Student Admissions Note   
Public Attribute cannot be edited on a Student Admissions Note   
Student Notable is not valid for Student   
top
 

StudentObject

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

Student_NotableObject

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

Student_NotableObjectID

part of: Student_NotableObject
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_Application_ID, Student_ID, Student_Prospect_Recruitment_ID, 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: Student_Admissions_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_Recruiting__Admissions__and_Public_NoteReferenceEnumeration

part of: Student_Recruiting__Admissions__and_Public_NoteObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Student_NotableReferenceEnumeration

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