Service Directory > v32.1 > Admissions > Put_Admissions_Note
 

Operation: Put_Admissions_Note

Creates or edits an Admissions Note using the information provided 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_Admissions_Note_Request

Put Student Admissions Note Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Admissions_Note_Reference  Student_Recruiting__Admissions__and_Public_NoteObject  [0..1]  Student Admission Note Secured   
Admissions_Note_Data  Student_Admissions_Note_Data  [0..1]  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   
 
Validation Description
The Web Service is set to Add Only but the Student Admissions Note already exists.   
top
 

Response Element: Put_Admissions_Note_Response

Put Student Admissions Note Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Admissions_Note_Reference  Student_Recruiting__Admissions__and_Public_NoteObject  [0..1]  Student Admissions Note   
top
 

Student_Recruiting__Admissions__and_Public_NoteObject

part of: Put_Admissions_Note_Request, Put_Admissions_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_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_Data

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