Service Directory > v32.1 > Student_Records > Get_Student_Schedules_for_Registration
 

Operation: Get_Student_Schedules_for_Registration

Returns Student Schedules for Registration by Reference ID, or returns all Student Schedule for Registrations if no Reference ID 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_Student_Schedules_for_Registration_Request

 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Schedule_for_Registration_Request_References  [0..1]     
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_Student_Schedules_for_Registration_Response

 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Schedule_for_Registration_Request_References  [0..1]     
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  Student_Schedule_for_Registration_Response_Data  [0..1]     
top
 

Student_Schedule_for_Registration_Request_References

part of: Get_Student_Schedules_for_Registration_Request, Get_Student_Schedules_for_Registration_Response
 
Parameter name Type/Value Cardinality Description Validations
Student_Schedule_for_Registration_Reference  Student_Schedule_for_RegistrationObject  [1..*]     
top
 

Student_Schedule_for_RegistrationObject

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

Student_Schedule_for_RegistrationObjectID

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

part of: Get_Student_Schedules_for_Registration_Response
 
Parameter name Type/Value Cardinality Description Validations
Student_Schedule_for_Registration  Student_Schedule_for_Registration  [0..*]  Student Schedule for Registration Response Data   
top
 

Student_Schedule_for_Registration

part of: Student_Schedule_for_Registration_Response_Data
Student Schedule for Registration Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Schedule_for_Registration_Reference  Student_Schedule_for_RegistrationObject  [0..1]  Element Container for Student Schedule for Registration   
Student_Schedule_for_Registration_Data  Student_Schedule_for_Registration_Data  [0..*]  Element Container for Registration Data 
Validation Description
Submit either Student Reference or Academic Record Reference.   
The Student must be matriculated and have an active Academic Record for Academic Period.   
Student has more than one Academic Record. Please submit Academic Record Reference. If using a version prior to v32.0, please update to the latest version.   
The student must have an academic plan.   
 
top
 

Student_Schedule_for_Registration_Data

part of: Student_Schedule_for_Registration
Student Schedule for Registration Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Element Container for ID   
Schedule_Name  string  [1..1]  Element Container for Student Schedule Name   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  Element Container for Academic Period   
Student_Reference  StudentObject  [0..1]  Element Container for Student Secured   
Academic_Record_Reference  Academic_RecordObject  [0..1]  Element Container for Academic Record Secured   
Student_Schedule_for_Registration_Item  Student_Schedule_for_Registration_Item  [0..*]  Element Container for Student Schedule for Registration Item 
Validation Description
Each course section of a course definition must have a unique instructional format.   
Course sections must be offered during specified academic period.   
The course section must have all required instructional format because its course definition requires it.   
The student schedule can only have published course sections.   
 
Validation Description
Submit either Student Reference or Academic Record Reference.   
The Student must be matriculated and have an active Academic Record for Academic Period.   
Student has more than one Academic Record. Please submit Academic Record Reference. If using a version prior to v32.0, please update to the latest version.   
The student must have an academic plan.   
top
 

Academic_PeriodObject

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

StudentObject

part of: Student_Schedule_for_Registration_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_RecordObject

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

Academic_RecordObjectID

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

part of: Student_Schedule_for_Registration_Data
Student Schedule for Registration Data
 
Parameter name Type/Value Cardinality Description Validations
Course_Section_Reference  Course_SectionObject  [0..*]  Element Container for Course Section   
Validation Description
Each course section of a course definition must have a unique instructional format.   
Course sections must be offered during specified academic period.   
The course section must have all required instructional format because its course definition requires it.   
The student schedule can only have published course sections.   
top
 

Course_SectionObject

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

Course_SectionObjectID

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

part of: Student_Schedule_for_RegistrationObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_RecordReferenceEnumeration

part of: Academic_RecordObjectID
Base Type
string
top
 

Course_SectionReferenceEnumeration

part of: Course_SectionObjectID
Base Type
string
top