Service Directory > v31.2 > Student_Records > Get_Course_Section_Co-Locations
 

Operation: Get_Course_Section_Co-Locations

Retrieves the Co-Located Course Sections for a Course Section


@ - 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_Co-Locations_Request

Request for the Get Course Section Co-Locations Web Service
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Course_Section_Co-Location_Request_References  [1..1]  Request Reference for the Course Section Co-Location Web Service   
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_Co-Locations_Response

Response for the Get Course Section Co-Location Web Service
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Course_Section_Co-Location_Request_References  [0..1]  Request Reference for the Course Section Co-Location Web Service   
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_Co-Location_Response_Data  [0..1]  Response Data for Get Course Section Co-Location   
top
 

Course_Section_Co-Location_Request_References

part of: Get_Course_Section_Co-Locations_Response, Get_Course_Section_Co-Locations_Request
Request Reference for the Course Section Co-Location Web Service
 
Parameter name Type/Value Cardinality Description Validations
Course_Section_Reference  Course_Section_DefinitionObject  [1..*]  The Course Sections to retrieve Co-Locations for   
top
 

Course_Section_DefinitionObject

part of: Course_Section_Co-Location_Data, Course_Section_Co-Location_Request_References, Course_Section_Co-Location
 
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_Co-Locations_Response, Get_Course_Section_Co-Locations_Request
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_Co-Locations_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_Co-Location_Response_Data

part of: Get_Course_Section_Co-Locations_Response
Response Data for Get Course Section Co-Location
 
Parameter name Type/Value Cardinality Description Validations
Course_Section_Co-Location  Course_Section_Co-Location  [0..*]  Contains the Course Sections and its Co-Locations   
top
 

Course_Section_Co-Location

part of: Course_Section_Co-Location_Response_Data
Contains the Course Sections and its Co-Locations
 
Parameter name Type/Value Cardinality Description Validations
Course_Section_Reference  Course_Section_DefinitionObject  [1..1]  Specifies the Course Section context for Co-Locations   
Course_Section_Co-Location_Data  Course_Section_Co-Location_Data  [0..1]  Contains the Co-Located Course Sections 
Validation Description
Only Course Sections with One Section Component can be Co-Located.   
 
top
 

Course_Section_Co-Location_Data

part of: Course_Section_Co-Location
Contains the Co-Located Course Sections
 
Parameter name Type/Value Cardinality Description Validations
Course_Section_Co-Location_Reference  Course_Section_DefinitionObject  [0..*]  The Co-Located Course Sections 
Validation Description
Only Course Sections in conflict can be Co-Located.   
 
Validation Description
Only Course Sections with One Section Component can be Co-Located.   
top
 

Course_Section_DefinitionReferenceEnumeration

part of: Course_Section_DefinitionObjectID
Base Type
string
top