Service Directory > v31.2 > Student_Records > Get_Course_Offering_Sets
 

Operation: Get_Course_Offering_Sets

Get Course Offering Sets Web Service Task.


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

Get Course Offering Sets Request element for Web Service.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Course_Offering_Set_Request_References  [0..1]  Course Offering Set Request References element for web service.   
Request_Criteria [Choice]   Course_Offering_Set_Request_Criteria  [0..1]  Course Offering Set Request Criteria element for 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_Offering_Sets_Response

Get Course Offering Sets Response element for Web Service.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Course_Offering_Set_Request_References  [0..1]  Course Offering Set Request References element for web service.   
Request_Criteria  Course_Offering_Set_Request_Criteria  [0..1]  Course Offering Set Request Criteria element for 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_Offering_Set_Response_Data  [0..1]  Course Offering Set Response Data element for Web Service.   
top
 

Course_Offering_Set_Request_References

part of: Get_Course_Offering_Sets_Request, Get_Course_Offering_Sets_Response
Course Offering Set Request References element for web service.
 
Parameter name Type/Value Cardinality Description Validations
Course_Offering_Set_Reference  Course_Offering_SetObject  [1..*]  Course Offering Set Reference   
top
 

Course_Offering_SetObject

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

Course_Offering_SetObjectID

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

part of: Get_Course_Offering_Sets_Request, Get_Course_Offering_Sets_Response
Course Offering Set Request Criteria element for Web Service.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Course_Offering_Sets_Request, Get_Course_Offering_Sets_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_Offering_Sets_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_Offering_Set_Response_Data

part of: Get_Course_Offering_Sets_Response
Course Offering Set Response Data element for Web Service.
 
Parameter name Type/Value Cardinality Description Validations
Course_Offering_Set  Course_Offering_Set  [0..*]  Course Offering Set element for Web Service.   
top
 

Course_Offering_Set

part of: Course_Offering_Set_Response_Data
Course Offering Set element for Web Service.
 
Parameter name Type/Value Cardinality Description Validations
Course_Offering_Set_Reference  Course_Offering_SetObject  [0..1]  Course Offering Set Reference.   
Course_Offering_Set_Data  Course_Offering_Set_Data  [0..*]  Course Offering Set Data element for Web Service.   
top
 

Course_Offering_Set_Data

part of: Course_Offering_Set
Course Offering Set Data element for Web Service.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Course Offering Set ID   
Student_Course_Reference  Course_DefinitionObject  [1..1]  Student Course Reference   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  Academic Period Abstract Reference   
Course_Section_for_Course_Offering_Set_Data  Course_Section_for_Course_Offering_Set_Data  [0..*]  Course Section for Course Offering Set Data   
top
 

Course_DefinitionObject

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

Academic_PeriodObject

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

Course_Section_for_Course_Offering_Set_Data

part of: Course_Offering_Set_Data
Course Section for Course Offering Set Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Course_Section_Reference  Course_Section_DefinitionObject  [0..1]  Student Course Section Reference   
Student_Course_Section_Data_for_Course_Offering_Set_Data  Student_Course_Section_Data_for_Course_Section_for_Course_Offering_Set_Data  [0..1]  Student Course Section Data for Course Section for Course Offering Set Data element.   
top
 

Course_Section_DefinitionObject

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

Student_Course_Section_Data_for_Course_Section_for_Course_Offering_Set_Data

part of: Course_Section_for_Course_Offering_Set_Data
Student Course Section Data for Course Section for Course Offering Set Data element.
 
Parameter name Type/Value Cardinality Description Validations
Student_Course_Section_Data_Reference  Unique_IdentifierObject  [0..1]  Student Course Section Data Reference   
Instructional_Format_Reference  Instructional_FormatObject  [1..1]  Instructional Format Reference   
Delivery_Mode_Reference  Delivery_ModeObject  [1..1]  Delivery Mode Reference   
Section_Listing_for_Course_Section_for_Course_Offering_Set_Data  Section_Listing_for_Course_Section_for_Course_Offering_Set_Data  [0..*]  Section Listing for Course Section for Course Offering Set Data element.   
Course_Section_Component_for_Course_Section_for_Course_Offering_Set_Data  Student_Course_Section_Component_for_Course_Section_for_Course_Offering_Set_Data  [0..*]  Student Course Section Component for Course Section for Course Offering Set Data element. 
Validation Description
The Meeting Pattern is not valid for the Academic Period.   
 
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Instructional_FormatObject

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

Instructional_FormatObjectID

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

Delivery_ModeObject

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

Delivery_ModeObjectID

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

Section_Listing_for_Course_Section_for_Course_Offering_Set_Data

part of: Student_Course_Section_Data_for_Course_Section_for_Course_Offering_Set_Data
Section Listing for Course Section for Course Offering Set Data element.
 
Parameter name Type/Value Cardinality Description Validations
Course_Listing_Reference  Course_ListingObject  [1..1]  Course Listing Reference   
Section_Number  string  [1..1]  Student Course Section Number   
Offering_ID  decimal (12, 0) >0   [0..1]  Course Section Offering ID   
top
 

Course_ListingObject

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

Course_ListingObjectID

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

part of: Student_Course_Section_Data_for_Course_Section_for_Course_Offering_Set_Data
Student Course Section Component for Course Section for Course Offering Set Data element.
 
Parameter name Type/Value Cardinality Description Validations
Student_Course_Section_Component_Reference  Unique_IdentifierObject  [0..1]  Student Course Section Component Reference   
Meeting_Pattern_Reference  Standard_Meeting_PatternObject  [0..1]  Meeting Pattern Reference   
Location_Reference  LocationObject  [0..1]  Location Reference   
Validation Description
The Meeting Pattern is not valid for the Academic Period.   
top
 

Standard_Meeting_PatternObject

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

Standard_Meeting_PatternObjectID

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

LocationObject

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

LocationObjectID

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

part of: Course_Offering_SetObjectID
Base Type
string
top
 

Course_DefinitionReferenceEnumeration

part of: Course_DefinitionObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Course_Section_DefinitionReferenceEnumeration

part of: Course_Section_DefinitionObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Instructional_FormatReferenceEnumeration

part of: Instructional_FormatObjectID
Base Type
string
top
 

Delivery_ModeReferenceEnumeration

part of: Delivery_ModeObjectID
Base Type
string
top
 

Course_ListingReferenceEnumeration

part of: Course_ListingObjectID
Base Type
string
top
 

Standard_Meeting_PatternReferenceEnumeration

part of: Standard_Meeting_PatternObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top