Service Directory > v32.1 > Academic_Foundation > Get_Student_Cohort_Memberships
 

Operation: Get_Student_Cohort_Memberships

Get 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: Get_Student_Cohort_Memberships_Request

Get Student Cohort Memberships Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Cohort_Membership_Request_References  [0..1]  Student Cohort Membership Request References   
Request_Criteria [Choice]   Student_Cohort_Membership_Request_Criteria  [0..1]  Student Cohort Membership Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Student_Cohort_Membership_Response_Group  [0..1]  Student Cohort Membership Response Group   
top
 

Response Element: Get_Student_Cohort_Memberships_Response

Get Student Cohort Memberships Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Cohort_Membership_Request_References  [0..1]  Student Cohort Membership Request References   
Request_Criteria  Student_Cohort_Membership_Request_Criteria  [0..1]  Student Cohort Membership Request Criteria   
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_Group  Student_Cohort_Membership_Response_Group  [0..1]  Student Cohort Membership Response Group   
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  Student_Cohort_Membership_Response_Data  [0..1]  Student Cohort Membership Response Data   
top
 

Student_Cohort_Membership_Request_References

part of: Get_Student_Cohort_Memberships_Response, Get_Student_Cohort_Memberships_Request
Student Cohort Membership Request References
 
Parameter name Type/Value Cardinality Description Validations
Student_Cohort_Reference  Student_GroupingObject  [1..*]  Student Cohort Reference   
top
 

Student_GroupingObject

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

Student_GroupingObjectID

part of: Student_GroupingObject
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_Request_Criteria

part of: Get_Student_Cohort_Memberships_Response, Get_Student_Cohort_Memberships_Request
Student Cohort Membership Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Cohort_Memberships_Response, Get_Student_Cohort_Memberships_Request
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
 

Student_Cohort_Membership_Response_Group

part of: Get_Student_Cohort_Memberships_Response, Get_Student_Cohort_Memberships_Request
Student Cohort Membership Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Student_Cohort_Membership_Response_Data

part of: Get_Student_Cohort_Memberships_Response
Student Cohort Membership Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Cohort_Membership  Student_Cohort_Membership  [0..*]  Student Cohort Membership   
top
 

Student_Cohort_Membership

part of: Student_Cohort_Membership_Response_Data
Student Cohort Membership
 
Parameter name Type/Value Cardinality Description Validations
Student_Cohort_Reference  Manual_Student_CohortObject  [0..1]  Student Cohort Reference   
Student_Cohort_Membership_Data  Student_Cohort_Membership_Data  [0..*]  Student Cohort Membership Data 
Validation Description
You can't submit multiple requests for the same student in a student cohort.   
 
top
 

Manual_Student_CohortObject

part of: Student_Cohort_Membership
 
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: Student_Cohort_Membership
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
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.   
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.   
You can't submit a student who isn't a member of [COHORT].   
Submit an Assignment Date for the student that is after the latest removal date from the cohort.   
Submit an Assignment Date for the student that is after the latest date of addition to the cohort.   
You can't submit a student who is already a member of [COHORT].   
Enter an Add as of Date that is on or after the matriculation date of [date].   
 
Validation Description
You can't submit multiple requests for the same student in a student cohort.   
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
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.   
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.   
You can't submit a student who isn't a member of [COHORT].   
Submit an Assignment Date for the student that is after the latest removal date from the cohort.   
Submit an Assignment Date for the student that is after the latest date of addition to the cohort.   
You can't submit a student who is already a member of [COHORT].   
Enter an Add as of Date that is on or after the matriculation date of [date].   
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
 

Student_GroupingReferenceEnumeration

part of: Student_GroupingObjectID
Base Type
string
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