Service Directory > v32.1 > Student_Records > Get_Course_Equivalency_Groups
 

Operation: Get_Course_Equivalency_Groups

Public Web Service for getting instances of Course Equivalency Group.


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

This is the Element that processes getting Course Equivalency Group by WID or Reference ID through this Web Service
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Course_Equivalency_Group_Request_References  [0..1]  The Course Equivalency Group Request element, which contains all fields used in a request for this Web Service.   
Request_Criteria [Choice]   Course_Equivalency_Group_Request_Criteria  [0..1]  The Course Equivalency Group Criteria Request Element, which contains all valid criteria fields used to make a request in the Web Service.   
Response_Filter  Response_Filter  [0..1]  The Course Equivalency Group Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Course_Equivalency_Groups_Response

The response element for requests to the Course Equivalency Group element Web Service
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Course_Equivalency_Group_Request_References  [0..1]  The element that handles returning instances of Course Equivalency Group by WID or Reference ID   
Request_Criteria  Course_Equivalency_Group_Request_Criteria  [0..1]  Element for getting instances of Course Equivalency Group by WID or Reference ID.   
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_Equivalency_Group_Response_Data  [0..1]  Response data element for the Course Equivalency Group Web Service.   
top
 

Course_Equivalency_Group_Request_References

part of: Get_Course_Equivalency_Groups_Request, Get_Course_Equivalency_Groups_Response
The element that handles returning instances of Course Equivalency Group by WID or Reference ID
 
Parameter name Type/Value Cardinality Description Validations
Course_Equivalency_Group_Reference  Course_Equivalency_GroupObject  [0..*]  Course Equivalency Group Web Service   
top
 

Course_Equivalency_GroupObject

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

Course_Equivalency_GroupObjectID

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

part of: Get_Course_Equivalency_Groups_Request, Get_Course_Equivalency_Groups_Response
Element for getting instances of Course Equivalency Group by WID or Reference ID.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Course_Equivalency_Groups_Request, Get_Course_Equivalency_Groups_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_Equivalency_Groups_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_Equivalency_Group_Response_Data

part of: Get_Course_Equivalency_Groups_Response
The Group Response data Element for the Course Equivalency Group Web Service
 
Parameter name Type/Value Cardinality Description Validations
Course_Equivalency_Group  Course_Equivalency_Group  [0..*]  The Course Equivalency Group Element for the Course Equivalency Group Web Service   
top
 

Course_Equivalency_Group

part of: Course_Equivalency_Group_Response_Data
The Course Equivalency Group Element for the Course Equivalency Group Web Service
 
Parameter name Type/Value Cardinality Description Validations
Course_Equivalency_Group_Reference  Course_Equivalency_GroupObject  [0..1]  The Course Equivalency Group Element for the Course Equivalency Group Web Service   
Course_Equivalency_Group_Data  Course_Equivalency_Group_Data  [0..*]  The Course Equivalency Group data element, containing all data fields for the web service 
Validation Description
Each Course Equivalency Group must contain two or more courses.   
Please enter an End Date that occurs after the Start Date.   
Maximum Units must be greater than 0 if equivalency usage of "Maximum Unit" is selected.   
Equivalency Usage Reference must be "Maximum Unit" in order to submit Maximum Units.   
Equivalency Usage Reference must be "Maximum Unit" in order to submit a Course Unit Type Reference.   
Course Unit Type is required when Usage Type is Maximum Units   
A course equivalency group with the same courses already exists for this date range. You must change the Start Date, End Date, or at least one of the Equivalent Courses.   
You cannot submit Equivalent Courses configured as Repeatable for Additional Credit within the specified date range for the course equivalency group.   
 
top
 

Course_Equivalency_Group_Data

part of: Course_Equivalency_Group
The data element, containing all data for a Course Equivalency Group web service request.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The Reference ID for Course Equivalency ID   
Start_Date  date  [1..1]  The date this equivalency group begins   
End_Date  date  [0..1]  The date this equivalency group ends   
Course_Unit_Type_Reference  Other_Unit_TypeObject  [0..1]  The Course Unit Type allowed, when the "Maximum Unit" equivalency usage is specified.   
Maximum_Units  decimal (7, 2) >0   [0..1]  The maximum units allowed, when the "Maximum Unit" equivalency usage is specified.   
Student_Course_Reference  Course_DefinitionObject  [0..*]  The courses in this equivalency group. There must be at least 2 in any group   
Equivalency_Usage_Reference  Course_Equivalency_UsageObject  [1..*]  The equivalency usage.   
Validation Description
Each Course Equivalency Group must contain two or more courses.   
Please enter an End Date that occurs after the Start Date.   
Maximum Units must be greater than 0 if equivalency usage of "Maximum Unit" is selected.   
Equivalency Usage Reference must be "Maximum Unit" in order to submit Maximum Units.   
Equivalency Usage Reference must be "Maximum Unit" in order to submit a Course Unit Type Reference.   
Course Unit Type is required when Usage Type is Maximum Units   
A course equivalency group with the same courses already exists for this date range. You must change the Start Date, End Date, or at least one of the Equivalent Courses.   
You cannot submit Equivalent Courses configured as Repeatable for Additional Credit within the specified date range for the course equivalency group.   
top
 

Other_Unit_TypeObject

part of: Course_Equivalency_Group_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_DefinitionObject

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

Course_Equivalency_UsageObject

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

Course_Equivalency_UsageObjectID

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

part of: Course_Equivalency_GroupObjectID
Base Type
string
top
 

Other_Unit_TypeReferenceEnumeration

part of: Other_Unit_TypeObjectID
Base Type
string
top
 

Course_DefinitionReferenceEnumeration

part of: Course_DefinitionObjectID
Base Type
string
top
 

Course_Equivalency_UsageReferenceEnumeration

part of: Course_Equivalency_UsageObjectID
Base Type
string
top