Service Directory > v32.1 > Student_Records > Put_FERPA_Preferences
 

Operation: Put_FERPA_Preferences

Updates existing FERPA Preferences 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_FERPA_Preferences_Request

Put FERPA Preferences Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
FERPA_Preferences_Data  FERPA_Preferences_Data  [1..1]  FERPA Preferences Data element. 
Validation Description
Please submit a valid institutional academic unit for this student.   
Included in Directory is not enterable.   
Student has no FERPA Preference for this Institutional Academic Unit.   
 
top
 

Response Element: Put_FERPA_Preferences_Response

Put FERPA Preferences Response element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Reference  StudentObject  [0..1]  Student for FERPA Preferences.   
Institutional_Academic_Unit_Reference  Academic_UnitObject  [0..1]  Institution Academic Unit for FERPA Preferences.   
top
 

FERPA_Preferences_Data

part of: Put_FERPA_Preferences_Request
FERPA Preferences Data element
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [1..1]  Student for FERPA Preferences.   
Institutional_Academic_Unit_Reference  Academic_UnitObject  [1..1]  Institutional Academic Unit for FERPA Preferences.   
Privacy_Block  boolean  [0..1]  Privacy Block attribute for FERPA Preferences.   
Included_in_Directory  boolean  [0..1]  Included in Directory attribute for FERPA Preferences.   
Validation Description
Please submit a valid institutional academic unit for this student.   
Included in Directory is not enterable.   
Student has no FERPA Preference for this Institutional Academic Unit.   
top
 

StudentObject

part of: Put_FERPA_Preferences_Response, FERPA_Preferences_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_UnitObject

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

Academic_UnitObjectID

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

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top