Service Directory > v31.2 > Student_Records > Get_Student_Course_Materials
 

Operation: Get_Student_Course_Materials

Returns Student Course Materials by Reference ID, or returns all Student Course Materials 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_Course_Materials_Request

Get Student Course Materials Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Course_Material_Request_References  [0..1]  Student Course Material Request References element   
Request_Criteria [Choice]   Student_Course_Material_Request_Criteria  [0..1]  Student Course Material Request Criteria element   
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_Course_Materials_Response

Get Student Course Materials Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Course_Material_Request_References  [0..1]  Student Course Material Request References element   
Request_Criteria  Student_Course_Material_Request_Criteria  [0..1]  Student Course Material Request Criteria element   
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_Course_Material_Response_Data  [0..1]  Student Course Material Response Data element   
top
 

Student_Course_Material_Request_References

part of: Get_Student_Course_Materials_Request, Get_Student_Course_Materials_Response
Student Course Material Request References element
 
Parameter name Type/Value Cardinality Description Validations
Student_Course_Material_Reference  Student_Course_MaterialObject  [1..*]  Workset for Student Course Material for which data is requested.   
top
 

Student_Course_MaterialObject

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

Student_Course_MaterialObjectID

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

part of: Get_Student_Course_Materials_Request, Get_Student_Course_Materials_Response
Student Course Material Request Criteria element
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Course_Materials_Request, Get_Student_Course_Materials_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_Course_Materials_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_Course_Material_Response_Data

part of: Get_Student_Course_Materials_Response
Student Course Material Response Data element
 
Parameter name Type/Value Cardinality Description Validations
Student_Course_Material  Student_Course_Material  [0..*]  Student Course Material element   
top
 

Student_Course_Material

part of: Student_Course_Material_Response_Data
Student Course Material element
 
Parameter name Type/Value Cardinality Description Validations
Student_Course_Material_Reference  Student_Course_MaterialObject  [0..1]  Instance of Student Course Material   
Student_Course_Material_Data  Student_Course_Material_Data  [0..*]  Student Course Material Data element 
Validation Description
Change the Currency to match the default currency for the student's academic unit: [currency]   
 
top
 

Student_Course_Material_Data

part of: Student_Course_Material
Student Course Material Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID for Student Course Material   
Student_Course_Material_Title  string  [1..1]  Title for Student Course Material   
Student_Course_Material_Author  string  [0..1]  Author for Student Course Material   
Student_Course_Material_Edition  string  [0..1]  Edition for Student Course Material   
Student_Course_Material_Publisher  string  [0..1]  Publisher for Student Course Material   
Student_Course_Material_Copyright_Date  date  [0..1]  Copyright Date for Student Course Material   
Student_Course_Material_ISBN  string  [0..1]  ISBN for Student Course Material   
Student_Course_Material_Retail_Price  decimal (15, 3) >0   [1..1]  Retail Price for Student Course Material   
Currency_Reference  CurrencyObject  [1..1]  Currency for Student Course Material   
Validation Description
Change the Currency to match the default currency for the student's academic unit: [currency]   
top
 

CurrencyObject

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

CurrencyObjectID

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

part of: Student_Course_MaterialObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top