Service Directory > v31.2 > Student_Records > Get_Course_Subjects
 

Operation: Get_Course_Subjects

Web Service Task, Get Course Subjects


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

Get Course Subjects Request Web Service Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Course_Subject_Request_References  [0..1]  Course Subject Reference   
Request_Criteria [Choice]   Course_Subject_Request_Criteria  [0..1]  Course Subject 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_Course_Subjects_Response

Course Subjects Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Course_Subject_Request_References  [0..1]  Course Subject Request References   
Request_Criteria  Course_Subject_Request_Criteria  [0..1]  Get Course Subjects Request   
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  Course_Subject_Response_Data  [0..1]  Course Subject Response Data   
top
 

Course_Subject_Request_References

part of: Get_Course_Subjects_Request, Get_Course_Subjects_Response
Course Subject Reference
 
Parameter name Type/Value Cardinality Description Validations
Course_Subject_Reference  Course_SubjectObject  [1..1]  Course Subject Reference   
top
 

Course_SubjectObject

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

Course_SubjectObjectID

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

Course_Subject_Request_Criteria

part of: Get_Course_Subjects_Request, Get_Course_Subjects_Response
Get Course Subjects Request
 
Parameter name Type/Value Cardinality Description Validations
Course_Subject_Name  string  [0..1]  Course Subject Name   
top
 

Response_Filter

part of: Get_Course_Subjects_Request, Get_Course_Subjects_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_Course_Subjects_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
 

Course_Subject_Response_Data

part of: Get_Course_Subjects_Response
Course Subject Response Data
 
Parameter name Type/Value Cardinality Description Validations
Course_Subject  Course_Subject  [0..*]  Web Service Element, Course Subject   
top
 

Course_Subject

part of: Course_Subject_Response_Data
Web Service Element containing a Course Subject.
 
Parameter name Type/Value Cardinality Description Validations
Course_Subject_Reference  Course_SubjectObject  [0..1]  Course Subject Reference instance   
Course_Subject_Data  Course_Subject_Data  [0..*]  Course Subject Data 
Validation Description
Enter a Course Subject Abbreviation not already in use.   
 
top
 

Course_Subject_Data

part of: Course_Subject
Course Subject Data
 
Parameter name Type/Value Cardinality Description Validations
Abbreviation  string  [1..1]  Course Subject Abbreviation   
Has_Institution_Academic_Unit_Data  Has_Institution_Academic_Unit_Data  [1..1]  Has Institution Academic Unit Data   
Course_Subject_Name  string  [1..1]  Course Subject Name   
Inactive  boolean  [0..1]  Course Subject Inactive   
Validation Description
Enter a Course Subject Abbreviation not already in use.   
top
 

Has_Institution_Academic_Unit_Data

part of: Course_Subject_Data
Course Subject Data
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_UnitObject  [1..*]  Academic Unit Reference   
top
 

Academic_UnitObject

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

Course_SubjectReferenceEnumeration

part of: Course_SubjectObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top