Service Directory > v31.2 > Student_Records > Get_Course_Section_Relationship
 

Operation: Get_Course_Section_Relationship

Public Web Service Operation for retrieving Course Section Relationships


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

Web Service Element for Get Course Section Relationship requests
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Course_Section_Relationship_Request_References  [0..1]  Specifies the Academic Period in which the Clustered Course Sections are offered.   
Request_Criteria [Choice]   Course_Section_Relationship_Request_Criteria  [0..1]  Web Service Element for specifying search criteria for Course Section Relationships   
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_Course_Section_Relationship_Response

Web Service Element for the Course Section Relationship Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Course_Section_Relationship_Request_References  [0..1]  Web Service Element for Course Section Relationship reference   
Request_Criteria  Course_Section_Relationship_Request_Criteria  [0..1]  Web Service Element for specifying search criteria for Course Section Relationships   
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  Course_Section_Relationship_Response_Data  [0..1]  Web Service Element for the Course Section Relationship Response Data   
top
 

Course_Section_Relationship_Request_References

part of: Get_Course_Section_Relationship_Request, Get_Course_Section_Relationship_Response
Web Service Element for Course Section Relationship reference
 
Parameter name Type/Value Cardinality Description Validations
Course_Section_Relationship_Reference  Student_Course_Section_ClusterObject  [1..*]  Specifies the Course Section Relationship to be returned.   
top
 

Student_Course_Section_ClusterObject

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

Student_Course_Section_ClusterObjectID

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

part of: Get_Course_Section_Relationship_Request, Get_Course_Section_Relationship_Response
Web Service Element for specifying search criteria for Course Section Relationships
 
Parameter name Type/Value Cardinality Description Validations
Academic_Period_Reference  Academic_PeriodObject  [0..1]  Specifies the Academic Period in which the Clustered Course Sections are offered.   
Courses_Reference  Course_DefinitionObject  [0..*]  Specifies the Courses for which the Clustered Course Sections are offered. 
Validation Description
Courses for Student Course Section Relationships must have sections offered in the Academic Period.   
 
Course_Sections_Reference  Course_Section_DefinitionObject  [0..*]  Specifies which specific Course Sections shall be present on the returned Clusters. 
Validation Description
Course Section must be offered in specified Academic Period   
 
top
 

Academic_PeriodObject

part of: Student_Course_Section_Cluster_Data, Course_Section_Relationship_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_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
 

Course_DefinitionObject

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

Course_DefinitionObjectID

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

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

Course_Section_DefinitionObjectID

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

part of: Get_Course_Section_Relationship_Response
Web Service Element for the Course Section Relationship Response Data
 
Parameter name Type/Value Cardinality Description Validations
Course_Section_Relationship  Course_Section_Relationship  [0..*]  Web Service Element for Course Section Relationship   
top
 

Course_Section_Relationship

part of: Course_Section_Relationship_Response_Data
Web Service Element for Course Section Relationship
 
Parameter name Type/Value Cardinality Description Validations
Course_Section_Relationship_Reference  Student_Course_Section_ClusterObject  [1..1]  Reference ID for the Course Section Relationship   
Course_Section_Relationship_Data  Student_Course_Section_Cluster_Data  [1..1]  The Web Service Element holding Course Section Relationship Data 
Validation Description
You must add a different course component to create a cluster   
You cannot add these course sections because one or more are already included in another cluster   
 
top
 

Student_Course_Section_Cluster_Data

part of: Course_Section_Relationship
The Web Service Element holding Course Section Relationship Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Course Section Relationship   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  The Academic Period for the Course Section Relationship   
Course_Sections_Reference  Course_Section_DefinitionObject  [1..*]  The Course Sections for the Course Section Relationship 
Validation Description
Course Section must be offered in specified Academic Period   
 
Validation Description
You must add a different course component to create a cluster   
You cannot add these course sections because one or more are already included in another cluster   
top
 

Student_Course_Section_ClusterReferenceEnumeration

part of: Student_Course_Section_ClusterObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Course_DefinitionReferenceEnumeration

part of: Course_DefinitionObjectID
Base Type
string
top
 

Course_Section_DefinitionReferenceEnumeration

part of: Course_Section_DefinitionObjectID
Base Type
string
top