Service Directory > v32.1 > Academic_Foundation > Put_Student_Cohort_Membership
 

Operation: Put_Student_Cohort_Membership

Put Student Cohort Membership information for a Student Cohort.


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

Put Student Cohort Membership Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Cohort_Reference  Manual_Student_CohortObject  [0..1]  Student Cohort Reference   
Student_Cohort_Membership_Data  Student_Cohort_Membership_Data  [1..1]  Student Cohort Membership Data 
Validation Description
You cannot submit more than one add or remove request for the same Student on the same Student Cohort. [NUMBER_OF_STUDENTS] Students have multiple add or remove requests, including [STUDENT]. Remove duplicate requests.   
 
Validation Description
A Student Cohort must be specified.   
top
 

Response Element: Put_Student_Cohort_Membership_Response

Put Student Cohort Membership Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Cohort_Membership_Reference  Manual_Student_CohortObject  [0..1]  Student Cohort Membership Reference   
top
 

Manual_Student_CohortObject

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

Manual_Student_CohortObjectID

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

part of: Put_Student_Cohort_Membership_Request
Student Cohort Membership Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID   
Student_Cohort_Assignment_Data  Student_Cohort_Assignment_Data  [0..*]  Student Cohort Assignment Data 
Validation Description
Enter an Assignment Date for [STUDENT] that is on or before Today's Date.   
Remove Cohort from Current Academic Period Cohort Membership Record cannot be set if Student Cohort Manual Assignment Type is Add.   
Remove Cohort from Current Academic Period Cohort Membership Record must be set if Student Cohort Assignment Type is Remove.   
[STUDENT] is already a member of [COHORT]   
[STUDENT] is not a member of [COHORT]   
Enter an Assignment Date for [STUDENT] that is after the latest Add date from this Cohort.   
Enter an Assignment Date for [STUDENT] that is after the latest Remove date from this Cohort.   
Submit either Student Reference or Academic Record Reference.   
Student has more than one Academic Record. Please submit Academic Record Reference. If using a version prior to v30.0, please update to the latest version.   
 
Validation Description
You cannot submit more than one add or remove request for the same Student on the same Student Cohort. [NUMBER_OF_STUDENTS] Students have multiple add or remove requests, including [STUDENT]. Remove duplicate requests.   
top
 

Student_Cohort_Assignment_Data

part of: Student_Cohort_Membership_Data
Student Cohort Assignment Data
 
Parameter name Type/Value Cardinality Description Validations
Assignment_Type_Reference  Student_Grouping_Assignment_TypeObject  [1..1]  Student Cohort Manual Assignment Type (Add or Remove)   
Student_Reference  StudentObject  [0..1]  Student Reference   
Academic_Record_Reference  Academic_RecordObject  [0..1]  Academic Record for Student   
Assignment_Date  dateTime  [0..1]  Assignment Date   
Remove_Cohort_from_Current_Academic_Period_Cohort_Membership_Record  boolean  [0..1]  Remove Cohort from Current Academic Period Cohort Membership Record   
Validation Description
Enter an Assignment Date for [STUDENT] that is on or before Today's Date.   
Remove Cohort from Current Academic Period Cohort Membership Record cannot be set if Student Cohort Manual Assignment Type is Add.   
Remove Cohort from Current Academic Period Cohort Membership Record must be set if Student Cohort Assignment Type is Remove.   
[STUDENT] is already a member of [COHORT]   
[STUDENT] is not a member of [COHORT]   
Enter an Assignment Date for [STUDENT] that is after the latest Add date from this Cohort.   
Enter an Assignment Date for [STUDENT] that is after the latest Remove date from this Cohort.   
Submit either Student Reference or Academic Record Reference.   
Student has more than one Academic Record. Please submit Academic Record Reference. If using a version prior to v30.0, please update to the latest version.   
top
 

Student_Grouping_Assignment_TypeObject

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

Student_Grouping_Assignment_TypeObjectID

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

StudentObject

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

StudentObjectID

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

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

Academic_RecordObjectID

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

Manual_Student_CohortReferenceEnumeration

part of: Manual_Student_CohortObjectID
Base Type
string
top
 

Student_Grouping_Assignment_TypeReferenceEnumeration

part of: Student_Grouping_Assignment_TypeObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_RecordReferenceEnumeration

part of: Academic_RecordObjectID
Base Type
string
top