Service Directory > v31.2 > Student_Records > Put_Course_Equivalency_Group
 

Operation: Put_Course_Equivalency_Group

Public Web Service for adding and updating Course Equivalency Groups


@ - 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: Put_Course_Equivalency_Group_Request

The Course Equivalency Group Request Element, containing all data for the Web Service.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Course_Equivalency_Group_Reference  Course_Equivalency_GroupObject  [0..1]  The element for accessing Course Equivalency Group by Reference ID.   
Course_Equivalency_Group_Data  Course_Equivalency_Group_Data  [0..1]  The data element for Course Equivalency Group, containing all 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.   
 
Validation Description
Web Service is set to Add Only, but the Course Equivalency Group already exists.   
top
 

Response Element: Put_Course_Equivalency_Group_Response

The Course Equivalency Put Response Element, which holds all fields returned from a Put request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Course_Equivalency_Group_Reference  Course_Equivalency_GroupObject  [0..1]  The Course Equivalency Group returned from a Put Request in the Web Service.   
top
 

Course_Equivalency_GroupObject

part of: Put_Course_Equivalency_Group_Request, Put_Course_Equivalency_Group_Response
 
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_Data

part of: Put_Course_Equivalency_Group_Request
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.   
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