Service Directory > v31.2 > Student_Records > Get_Historical_Students
 

Operation: Get_Historical_Students

Retrieves Historical Student data by reference or criteria, or returns all Historical Students if no reference or criteria is specified.


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

Get Historical Students Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Historical_Student_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Historical_Student_Request_Criteria  [0..1]  Request criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Historical_Students_Response

Get Historical Students Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Historical_Student_Request_References  [0..1]  Request References   
Request_Criteria  Historical_Student_Request_Criteria  [0..1]  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  Historical_Student_Response_Data  [0..1]  Contains instructor data for each request reference. The data is current as of the dates in the response filter, and doesn't include all historical information.   
top
 

Historical_Student_Request_References

part of: Get_Historical_Students_Request, Get_Historical_Students_Response
Historical Student Request References
 
Parameter name Type/Value Cardinality Description Validations
Historical_Student_Reference  Historical_StudentObject  [1..*]  Historical Student Reference   
top
 

Historical_StudentObject

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

Historical_StudentObjectID

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

Historical_Student_Request_Criteria

part of: Get_Historical_Students_Request, Get_Historical_Students_Response
Historical Student Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Historical_Students_Request, Get_Historical_Students_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_Historical_Students_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
 

Historical_Student_Response_Data

part of: Get_Historical_Students_Response
Historical Student Response Data
 
Parameter name Type/Value Cardinality Description Validations
Historical_Student  Historical_Student  [0..*]  Historical Student   
top
 

Historical_Student

part of: Historical_Student_Response_Data
Historical Student
 
Parameter name Type/Value Cardinality Description Validations
Historical_Student_Reference  Historical_StudentObject  [0..1]  Historical Student Reference   
Historical_Student_Data  Historical_Student_Data  [0..*]  Historical Student Data   
top
 

Historical_Student_Data

part of: Historical_Student
Historical Student Data
 
Parameter name Type/Value Cardinality Description Validations
Student_ID  string  [0..1]  Historical Student ID   
First_Name  string  [1..1]  Historical Student First Name   
Middle_Name  string  [0..1]  Historical Student Middle Name   
Last_Name  string  [1..1]  Historical Student Last Name   
National_ID  string  [1..1]  Historical Student National ID   
Gender  string  [1..1]  Historical Student Gender   
Date_of_Birth  date  [1..1]  Historical Student Date of Birth   
Contact_Information  string  [0..1]  Historical Student Contact Information   
Historical_Student_Record_Data  Historical_Academic_Record_Data  [1..*]  Historical Student Record Data element   
Historical_Student_Write-Off_Data  Historical_Student_Write-Off_Data  [0..*]  Historical Student Write-Off Data element   
Historical_Student_Hold_Data  Historical_Student_Hold_Data  [0..*]  Historical Student Hold Data element 
Validation Description
Student Hold Assignments cannot have Student Hold Reason of Outstanding Action Item.   
Award Year is only a valid context with a Hold Type of ISIR Review, Disbursement, or Packaging.   
Federal School Code Rule Set is Required if Hold Type is ISIR Review, Disbursement, or Packaging.   
Federal School Code Rule Set is only valid context for a Hold Type of ISIR Review, Disbursement, or Packaging.   
Academic Period is only a valid context with a Hold Type of Full Registration and Registration Add.   
The Hold Type is not a valid Hold Type for this Hold Reason.   
 
top
 

Historical_Academic_Record_Data

part of: Historical_Student_Data
Historical Student Record Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Reference ID of the Historical Student Record   
Institutional_Academic_Unit_Reference  Academic_UnitObject  [1..1]  Institutional Academic Unit   
Institution  string  [1..1]  Historical Student Institution Name   
Academic_Unit  string  [1..1]  Historical Student Record Academic Unit   
Academic_Level  string  [1..1]  Historical Student Record Academic Level   
Honor_or_Award  string  [0..1]  Historical Student Record Honor or Award   
Total_Transfer_Units  decimal (30, 10) >0   [0..1]  Historical Student Record Total Transfer Units   
Historical_Program_of_Study_Record_Data  Historical_Program_of_Study_Record_Data  [1..*]  Historical Program of Study Record Data   
Historical_Academic_Period_Record_Data  Historical_Academic_Period_Record_Data  [0..*]  Historical Academic Period Record Data element   
Historical_Student_Test_Articulation_Data  Historical_Student_Test_Articulation_Data  [0..*]  Historical Student Test Articulation Data   
top
 

Academic_UnitObject

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

Historical_Program_of_Study_Record_Data

part of: Historical_Academic_Record_Data
Historical Program of Study Record Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Historical Program of Study Record ID   
Program_of_Study  string  [1..1]  Historical Program of Study Record Program of Study   
Academic_Unit  string  [1..1]  Historical Program of Study Record Academic Unit   
Academic_Level  string  [1..1]  Historical Program of Study Record Academic Level   
First_Entry_Date  date  [1..1]  Historical Program of Study Record First Entry Date   
Expected_Completion_Date  date  [0..1]  Historical Program of Study Record Expected Completion Date   
Conferral_Status  string  [1..1]  Historical Program of Study Record Conferral Status   
Conferral_Date  date  [0..1]  Historical Program of Study Record Conferral Date   
Educational_Credential  string  [0..1]  Historical Program of Study Record Educational Credential   
top
 

Historical_Academic_Period_Record_Data

part of: Historical_Academic_Record_Data
Historical Academic Period Record Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Reference ID of the Historical Student Academic Period Record   
Academic_Period  string  [1..1]  Historical Student Academic Period Record Academic Period   
Academic_Period_Programs_of_Study  string  [0..1]  Historical Student Academic Period Record Programs of Study   
Academic_Period_Academic_Unit  string  [0..1]  Historical Student Academic Period Record Academic Unit   
Academic_Period_Total_Units_Attempted  decimal (30, 10) >0   [0..1]  Historical Student Academic Period Total Units Attempted   
Academic_Period_Total_Units_Earned  decimal (30, 10) >0   [0..1]  Historical Student Academic Period Total Units Earned   
Academic_Period_Total_GPA_Units_Earned  decimal (30, 10) >0   [0..1]  Historical Student Academic Period Record Total GPA Units Earned   
Academic_Period_Cumulative_Units_Earned  decimal (30, 10) >0   [0..1]  Historical Student Academic Period Record Cumulative Units Earned   
Academic_Period_Cumulative_GPA_Units_Earned  decimal (30, 10) >0   [0..1]  Historical Student Academic Period Record Cumulative GPA Units Earned   
Start_Date  date  [1..1]  Historical Student Academic Period Record Start Date   
Period_GPA  decimal (9, 6) >0   [0..1]  Historical Student Academic Period Record Period GPA   
Cumulative_GPA  decimal (9, 6) >0   [0..1]  Historical Student Academic Period Record Cumulative GPA   
Academic_Standing  string  [0..1]  Historical Student Academic Period Record Academic Standing   
Academic_Progress  string  [0..1]  Historical Program of Study Record Student Academic Progress   
Historical_Student_Registration_Data  Historical_Student_Registration_Data  [1..*]  Historical Student Registration Data element   
Historical_Articulated_Registration_Data  Historical_Articulated_Registration_Data  [0..*]  Historical Articulated Registration Data element   
top
 

Historical_Student_Registration_Data

part of: Historical_Academic_Period_Record_Data
Historical Student Registration Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Reference ID of the Historical Student Registration   
Historical_Course_ID  string  [0..1]  Historical Course ID   
Course  string  [1..1]  Historical Student Registration Course   
Course_Title  string  [0..1]  Historical Student Registration Course Title   
Instructor  string  [0..1]  Historical Student Registration Instructor   
Academic_Unit  string  [1..1]  Historical Student Registration Academic Unit   
Units  decimal (9, 3) >0   [0..1]  Historical Student Registration Units   
Grade  string  [0..1]  Historical Student Registration Grade   
Grade_Points  decimal (6, 3) >0   [0..1]  Historical Student Registration Grade Points   
Competencies  string  [0..1]  Historical Student Registration Competencies   
Replaced_Registration  string  [0..1]  Historical Student Registration Replaced Registration   
Repeated_Registration  string  [0..1]  Historical Student Registration Repeated Registration   
top
 

Historical_Articulated_Registration_Data

part of: Historical_Academic_Period_Record_Data
Historical Articulated Registration Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Reference ID of the Historical Articulated Registration   
Historical_Course_ID  string  [0..1]  Historical Course ID   
Historical_Student_Registration_Course  string  [1..1]  Historical Student Registration Course   
Historical_Student_Registration_Units  decimal (9, 3) >0   [0..1]  Historical Student Registration Units   
Historical_Student_Registration_Grade  string  [0..1]  Historical Student Registration Grade   
Historical_Student_Registration_Grade_Points  decimal (6, 3) >0   [0..1]  Historical Student Registration Grade Points   
Historical_Articulated_Registration_External_Records  string  [1..1]  Historical Articulated Registration External Records   
Historical_Student_Registration_Competencies  string  [0..1]  Historical Student Registration Competencies   
Historical_Articulated_Registration_Educational_Institution  string  [1..1]  Historical Articulated Registration Educational Institution   
Historical_Articulated_Registration_Educational_Institution_School_Level  string  [1..1]  Historical Articulated Registration Educational Institution School Level   
top
 

Historical_Student_Test_Articulation_Data

part of: Historical_Academic_Record_Data
Historical Student Record Data Element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Reference ID of the Historical Student Test Articulation.   
Course  string  [0..1]  The Course for the Historical Student Test Articulation.   
Units  decimal (9, 3) >0   [0..1]  The Units for the Historical Student Test Articulation.   
Grade  string  [0..1]  The Grade for the Historical Student Test Articulation.   
Grade_Points  decimal (6, 3) >0   [0..1]  The Grade Points for the Historical Student Test Articulation.   
Education_Test_Section_Result  string  [0..1]  The Education Test Section Result for the Historical Student Test Articulation.   
top
 

Historical_Student_Write-Off_Data

part of: Historical_Student_Data
Historical Student Write-Off Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Reference ID of the Historical Student Write-Off   
Write-Off_Item  string  [1..1]  Historical Student Write-Off Item   
Write-Off_Amount  decimal (18, 3) >0   [1..1]  Historical Student Write-Off Amount   
Write-Off_Date  string  [1..1]  Historical Student Write-Off Date   
top
 

Historical_Student_Hold_Data

part of: Historical_Student_Data
Historical Student Hold Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Reference ID of the Student Hold Assignment   
Student_Hold_Reason_Reference  Student_Hold_Reason__All_Object  [1..1]  Historical Student Hold Reason   
Student_Hold_Reference  Student_Hold__All_Object  [1..1]  Historical Student Hold   
Federal_School_Code_Rule_Set_Reference  Federal_School_Code_Rule_SetObject  [0..1]  Historical Student Federal School Code Rule Set   
Financial_Aid_Award_Year_Reference  Financial_Aid_Award_YearObject  [0..1]  Historical Student Financial Aid Award Year   
Academic_Period_Reference  Academic_PeriodObject  [0..1]  Historical Student Academic Period   
Validation Description
Student Hold Assignments cannot have Student Hold Reason of Outstanding Action Item.   
Award Year is only a valid context with a Hold Type of ISIR Review, Disbursement, or Packaging.   
Federal School Code Rule Set is Required if Hold Type is ISIR Review, Disbursement, or Packaging.   
Federal School Code Rule Set is only valid context for a Hold Type of ISIR Review, Disbursement, or Packaging.   
Academic Period is only a valid context with a Hold Type of Full Registration and Registration Add.   
The Hold Type is not a valid Hold Type for this Hold Reason.   
top
 

Student_Hold_Reason__All_Object

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

Student_Hold_Reason__All_ObjectID

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

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

Student_Hold__All_ObjectID

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

Federal_School_Code_Rule_SetObject

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

Federal_School_Code_Rule_SetObjectID

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

Financial_Aid_Award_YearObject

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

Financial_Aid_Award_YearObjectID

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

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

Academic_PeriodObjectID

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

Historical_StudentReferenceEnumeration

part of: Historical_StudentObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Student_Hold_Reason__All_ReferenceEnumeration

part of: Student_Hold_Reason__All_ObjectID
Base Type
string
top
 

Student_Hold__All_ReferenceEnumeration

part of: Student_Hold__All_ObjectID
Base Type
string
top
 

Federal_School_Code_Rule_SetReferenceEnumeration

part of: Federal_School_Code_Rule_SetObjectID
Base Type
string
top
 

Financial_Aid_Award_YearReferenceEnumeration

part of: Financial_Aid_Award_YearObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top