Service Directory > v32.1 > Student_Records > Get_FERPA_Preferences
 

Operation: Get_FERPA_Preferences

Returns FERPA Preferences by Student and Institutional Academic Unit, Student, or returns all FERPA Preferences if no criteria is provided.


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

Get FERPA Preferences Request element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   FERPA_Preferences_Request_References  [0..1]  FERPA Preferences Request References element.   
Request_Criteria [Choice]   FERPA_Preferences_Request_Criteria  [0..1]  FERPA Preferences Request Criteria 
Validation Description
Institutional Academic Unit cannot be provided without reference to a 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_FERPA_Preferences_Response

Get FERPA Preferences Response element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  FERPA_Preferences_Request_References  [0..1]  FERPA Preferences Request References element.   
Request_Criteria  FERPA_Preferences_Request_Criteria  [0..1]  FERPA Preferences Request Criteria element. 
Validation Description
Institutional Academic Unit cannot be provided without reference to a 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. 
 
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  FERPA_Preferences_Response_Data  [0..1]  Get FERPA Preferences Response element.   
top
 

FERPA_Preferences_Request_References

part of: Get_FERPA_Preferences_Response, Get_FERPA_Preferences_Request
FERPA Preferences Request References element.
 
Parameter name Type/Value Cardinality Description Validations
top
 

FERPA_Preferences_Request_Criteria

part of: Get_FERPA_Preferences_Response, Get_FERPA_Preferences_Request
FERPA Preferences Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..*]  Students for FERPA Preferences Request Criteria.   
Institutional_Academic_Unit_Reference  Academic_UnitObject  [0..1]  Institution Academic Unit for FERPA Preferences Request Criteria.   
Validation Description
Institutional Academic Unit cannot be provided without reference to a Student.   
top
 

StudentObject

part of: FERPA_Preferences, FERPA_Preferences_Data, FERPA_Preferences_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
 

Academic_UnitObject

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

Response_Filter

part of: Get_FERPA_Preferences_Response, Get_FERPA_Preferences_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_FERPA_Preferences_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
 

FERPA_Preferences_Response_Data

part of: Get_FERPA_Preferences_Response
Get FERPA Preferences Response element.
 
Parameter name Type/Value Cardinality Description Validations
FERPA_Preferences  FERPA_Preferences  [0..*]  FERPA Preferences element   
top
 

FERPA_Preferences

part of: FERPA_Preferences_Response_Data
FERPA Preferences element
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [0..1]  Student for FERPA Preferences.   
FERPA_Preferences_Data  FERPA_Preferences_Data  [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
 

FERPA_Preferences_Data

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

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top