Service Directory > v31.2 > Student_Records > Get_Orientation_Offerings
 

Operation: Get_Orientation_Offerings

Web service for getting Orientation Offerings.


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

Orientation Offerings Request Data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Orientation_Offering_Request_References  [0..1]  Orientation Offering Request References.   
Request_Criteria [Choice]   Orientation_Offering_Request_Criteria  [0..1]  Orientation Offering 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_Orientation_Offerings_Response

Orientation Offerings Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Orientation_Offering_Request_References  [0..1]  Request References for Orientation Offering.   
Request_Criteria  Orientation_Offering_Request_Criteria  [0..1]  Criteria for Selecting Orientation Offerings.   
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  Orientation_Offering_Response_Data  [0..1]  Orientation Offerings Response   
top
 

Orientation_Offering_Request_References

part of: Get_Orientation_Offerings_Request, Get_Orientation_Offerings_Response
Request References for Orientation Offering.
 
Parameter name Type/Value Cardinality Description Validations
Orientation_Offering_Reference  Orientation_OfferingObject  [1..*]  Orientation Offerings returned based on reference.   
top
 

Orientation_OfferingObject

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

Orientation_OfferingObjectID

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

Orientation_Offering_Request_Criteria

part of: Get_Orientation_Offerings_Request, Get_Orientation_Offerings_Response
Criteria for Selecting Orientation Offerings.
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [0..1]  Academic Unit for Criteria.   
top
 

Academic_Curricular_DivisionObject

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

Academic_Curricular_DivisionObjectID

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

Response_Filter

part of: Get_Orientation_Offerings_Request, Get_Orientation_Offerings_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_Orientation_Offerings_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
 

Orientation_Offering_Response_Data

part of: Get_Orientation_Offerings_Response
Orientation Offerings Response
 
Parameter name Type/Value Cardinality Description Validations
Orientation_Offering  Orientation_Offering  [0..*]  Orientation Offering Response Data.   
top
 

Orientation_Offering

part of: Orientation_Offering_Response_Data
Orientation Offering Response Data.
 
Parameter name Type/Value Cardinality Description Validations
Orientation_Offering_Reference  Orientation_OfferingObject  [0..1]  Orientation Offering Instance.   
Orientation_Offering_Data  Orientation_Offering_Data  [0..*]  Orientation Offering Data. 
Validation Description
Must select the Schedulable Activity Behavior to submit Schedulable Data.   
Must select the Billable Activity Behavior to submit Billable Data.   
Must select the Enrollable Activity Behavior to submit Enrollable Data.   
 
top
 

Orientation_Offering_Data

part of: Orientation_Offering
Orientation Offering Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Orientation Offering Reference ID.   
Orientation_Reference  OrientationObject  [1..1]  Orientation Reference.   
Behaviored_Activity_Offering_Data  Activity_Offering_Data  [0..*]  Behaviored Activity Offering Data.   
Orientation_Offering_Specific_Data  Orientation_Offering_Specific_Data  [0..*]  Orientation Offering Specific Data.   
Has_Academic_Curricular_Division_Data  Has_Academic_Curricular_Division_Data  [0..*]  Academic Curricular Division Data. 
Validation Description
Academic Level is required.   
Only a single academic level is allowed.   
The Academic Unit is not valid for the selected Academic Level.   
 
Activity_Offering_Data_Has_Academic_Period_Data  Activity_Offering_Data_Has_Academic_Period_Data  [0..*]  Activity Offering Data Has Academic Period Data 
Validation Description
End Date cannot be before the Start Date.   
 
Has_Enrollable_Eligibility_Data  Has_Enrollable_Eligibility_Data  [0..*]  Enrollable Eligibility Data.   
Has_Billable_Load_Status_Data  Has_Billable_Load_Status_Data  [0..*]  Billable Load Status Data. 
Validation Description
You must specify at least 1 Other Unit Type and Other Unit Value when you select the Other Unit Values check box.   
 
Has_Schedulable_Data  Has_Schedulable_Data  [0..*]  Schedulable Data.   
Validation Description
Must select the Schedulable Activity Behavior to submit Schedulable Data.   
Must select the Billable Activity Behavior to submit Billable Data.   
Must select the Enrollable Activity Behavior to submit Enrollable Data.   
top
 

OrientationObject

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

OrientationObjectID

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

Activity_Offering_Data

part of: Orientation_Offering_Data
Activity Offering Data
 
Parameter name Type/Value Cardinality Description Validations
Title  string  [1..1]  Title   
Abbreviated_Title  string  [1..1]  Abbreviated Title   
top
 

Orientation_Offering_Specific_Data

part of: Orientation_Offering_Data
Orientation Offering Specific Data.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Has_Academic_Curricular_Division_Data

part of: Orientation_Offering_Data
Wrapper element for the Has Academic Unit Data which contains an Academic Unit and Academic Level
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  Academic Unit 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic Level Nonsingular Workset   
Validation Description
Academic Level is required.   
Only a single academic level is allowed.   
The Academic Unit is not valid for the selected Academic Level.   
top
 

Academic_LevelObject

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

Academic_LevelObjectID

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

Activity_Offering_Data_Has_Academic_Period_Data

part of: Orientation_Offering_Data
The Activity Offering Data Has Academic Period Data holds the Academic Period, Activity Offering Start and the Activity Offering End Date for the Orientation Offering
 
Parameter name Type/Value Cardinality Description Validations
Academic_Period_Reference  Academic_PeriodObject  [0..1]  Academic Period Reference   
Start_Date  date  [1..1]  Start Date 
Validation Description
The selected Start Date is before the Academic Period Start Date.   
 
End_Date  date  [1..1]  End Date 
Validation Description
The selected End Date is after the Academic Period End Date.   
 
Validation Description
End Date cannot be before the Start Date.   
top
 

Academic_PeriodObject

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

Has_Enrollable_Eligibility_Data

part of: Orientation_Offering_Data
Enrollable and Eligibility Data
 
Parameter name Type/Value Cardinality Description Validations
Unlimited_Capacity  boolean  [0..1]  Unlimited Capacity.   
Section_Capacity  decimal (6, 0) >0   [0..1]  Capacity.   
Wait_List_Capacity  decimal (6, 0) >0   [0..1]  Wait List.   
Reserved_Capacity  decimal (6, 0) >0   [0..1]  Reserved Capacity.   
Projected_Enrollment  decimal (12, 0) >0   [0..1]  Projected Enrollment.   
top
 

Has_Billable_Load_Status_Data

part of: Orientation_Offering_Data
Billable Load Status Data
 
Parameter name Type/Value Cardinality Description Validations
Unit_Type_Reference  Other_Unit_TypeObject  [0..1]  Unit Type Reference   
Minimum_Units  decimal (8, 2) >0   [0..1]  Minimum Units.   
Maximum_Units  decimal (8, 2) >0   [0..1]  Maximum Units.   
Contact_Hours  decimal (8, 2) >0   [0..1]  Contact Hours.   
Other_Credit_Values  boolean  [0..1]  Other Credit Values.   
Other_Credit_Type_Value_Data  Course_Section_Other_Credit_Type_Value_Data  [0..*]  Contains data for Other Credit Type Values for Course Section   
Validation Description
You must specify at least 1 Other Unit Type and Other Unit Value when you select the Other Unit Values check box.   
top
 

Other_Unit_TypeObject

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

Other_Unit_TypeObjectID

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

part of: Has_Billable_Load_Status_Data
Contains data for Other Credit Type Values for Course Section
 
Parameter name Type/Value Cardinality Description Validations
Other_Credit_Type_Reference  Other_Credit_TypeObject  [0..*]  References Other Credit Type for Course Section 
Validation Description
Other Credit Values must be true in order to submit an Other Credit Type and value combination.   
 
Other_Credit_Value  decimal (5, 2) >0   [0..1]  Specifies the Value for an Other Credit Type on Course Section   
top
 

Other_Credit_TypeObject

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

Other_Credit_TypeObjectID

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

Has_Schedulable_Data

part of: Orientation_Offering_Data
Schedulable Data
 
Parameter name Type/Value Cardinality Description Validations
Behaviored_Activity_Component_Data  Behaviored_Activity_Component_Data  [0..*]  Behaviored Activity Component Data holds the Custom Meeting Pattern and Location for the Activity Offering 
Validation Description
This meeting pattern and location combination overlaps with that for another course section or activity. Enter a different location or a meeting pattern that doesn't overlap with other meeting patterns.   
Validation Description
Enter a Meeting Pattern and Location combination not already in use for this Activity.   
Enter a different location or a meeting pattern that doesn't overlap with any other meeting patterns for this activity.   
 
top
 

Behaviored_Activity_Component_Data

part of: Has_Schedulable_Data
Behaviored Activity Component Data holds the Custom Meeting Pattern and Location for the Activity Offering
 
Parameter name Type/Value Cardinality Description Validations
Custom_Meeting_Pattern_Data  Custom_Meeting_Pattern_Data  [0..1]  Custom Meeting Pattern Data Element 
Validation Description
End time must not be before start time.   
The Meeting Day Pattern must occur at least once within the Start and End Dates of the Meeting Pattern   
Custom Meeting Pattern End Date must be on or before the Activity Offering End Date   
Custom Meeting Pattern Start Date must be on or after the Activity Offering Start Date   
 
Location_Reference  LocationObject  [0..1]  Location   
Validation Description
Enter a Meeting Pattern and Location combination not already in use for this Activity.   
Enter a different location or a meeting pattern that doesn't overlap with any other meeting patterns for this activity.   
top
 

Custom_Meeting_Pattern_Data

part of: Behaviored_Activity_Component_Data
Custom Meeting Pattern Data Element
 
Parameter name Type/Value Cardinality Description Validations
Start_Date  date  [1..1]  Custom Meeting Pattern Start Date 
Validation Description
The custom meeting pattern must fall within the date range of the section   
 
End_Date  date  [1..1]  Custom Meeting Pattern End Date 
Validation Description
The custom meeting pattern must fall within the date range of the section   
 
Start_Time  time  [1..1]  Meeting Pattern Start Time   
End_Time  time  [1..1]  Meeting Pattern End Time   
Meeting_Day_Pattern_Reference  Meeting_Day_PatternObject  [1..1]  Meeting Day Pattern for Custom Meeting Pattern   
Validation Description
End time must not be before start time.   
The Meeting Day Pattern must occur at least once within the Start and End Dates of the Meeting Pattern   
Custom Meeting Pattern End Date must be on or before the Activity Offering End Date   
Custom Meeting Pattern Start Date must be on or after the Activity Offering Start Date   
top
 

Meeting_Day_PatternObject

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

Meeting_Day_PatternObjectID

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

Orientation_OfferingReferenceEnumeration

part of: Orientation_OfferingObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

OrientationReferenceEnumeration

part of: OrientationObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Other_Unit_TypeReferenceEnumeration

part of: Other_Unit_TypeObjectID
Base Type
string
top
 

Other_Credit_TypeReferenceEnumeration

part of: Other_Credit_TypeObjectID
Base Type
string
top
 

Meeting_Day_PatternReferenceEnumeration

part of: Meeting_Day_PatternObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top