Service Directory > v31.2 > Admissions > Get_Admissions_Cohorts
 

Operation: Get_Admissions_Cohorts

Gets specific Admissions Cohorts if a reference is provided, or the operation returns all Admissions Cohorts if none are provided.


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

The Get Admissions Cohort Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Admissions_Cohort_Request_References  [0..1]  Contains the data for requesting a specific Admissions Cohort.   
Request_Criteria [Choice]   Admissions_Cohort_Request_Criteria  [0..1]  Contains criteria for specifying which Admissions Cohorts to return.   
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. 
 
top
 

Response Element: Get_Admissions_Cohorts_Response

The response for a Get Admissions Cohort request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Admissions_Cohort_Request_References  [0..1]  Contains the data for requesting a specific Admissions Cohort.   
Request_Criteria  Admissions_Cohort_Request_Criteria  [0..1]  Contains criteria for specifying which Admissions Cohorts to return.   
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  Admissions_Cohort_Response_Data  [0..1]  Contains the response data for a Get Admissions Cohort request.   
top
 

Admissions_Cohort_Request_References

part of: Get_Admissions_Cohorts_Request, Get_Admissions_Cohorts_Response
Contains the data for requesting a specific Admissions Cohort.
 
Parameter name Type/Value Cardinality Description Validations
Admissions_Cohort_Reference  Admissions_CohortObject  [1..*]  The specific Admissions Cohorts to return.   
top
 

Admissions_CohortObject

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

Admissions_CohortObjectID

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

Admissions_Cohort_Request_Criteria

part of: Get_Admissions_Cohorts_Request, Get_Admissions_Cohorts_Response
Contains criteria for specifying which Admissions Cohorts to return.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Admissions_Cohorts_Request, Get_Admissions_Cohorts_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_Admissions_Cohorts_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
 

Admissions_Cohort_Response_Data

part of: Get_Admissions_Cohorts_Response
Contains the response data for a Get Admissions Cohort request.
 
Parameter name Type/Value Cardinality Description Validations
Admissions_Cohort  Admissions_Cohort  [0..*]  Contains the Admissions Cohort response data.   
top
 

Admissions_Cohort

part of: Admissions_Cohort_Response_Data
Contains the Admissions Cohort response data.
 
Parameter name Type/Value Cardinality Description Validations
Admissions_Cohort_Reference  Admissions_CohortObject  [1..1]  The instance of the requested Cohort.   
Admissions_Cohort_Data  Admissions_Cohort_Data  [0..*]  The information about an Admissions Cohort, consisting of subelements containing specific data 
Validation Description
Select a unique combination of Academic Level, Academic Unit and academic period. For dynamic periods, the start and end dates can't overlap dates for existing cohorts.   
Enter a Materials Due By date that is on or after the Applications Received By date.   
Enter an Admission Responses Received By date that is on or after the Decisions Published By date.   
Enter a Decisions Published By date that is on or after the Decisions Rendered By date.   
Enter a Decisions Rendered By date that is on or after the Materials Due Date.   
Enter a Cohort Name that isn't already in use.   
Selected Admissions Counselor is Inactive   
Add Only is False and data other than the editable fields was changed.   
The Academic Period must be valid for the selected Academic Unit and Academic Level.   
Cannot create Dynamic Admissions Cohort for Fixed only Academic Unit Configuration.   
 
top
 

Admissions_Cohort_Data

part of: Admissions_Cohort
The information about an Admissions Cohort, consisting of subelements containing specific data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the Admissions Cohort.   
Admissions_Cohort_Name  string  [0..1]  Name of the Admissions Cohort. If left blank, this value will default to the Academic Unit - Level   
Academic_Unit_Data  Academic_Curricular_Division_Subedit_Data  [1..1]  Academic Curricular Devision Data for the Admissions Cohort 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
 
Academic_Period_Data  Academic_Periods_Subedit_Data  [1..1]  Contains Academic Periods information for an Admissions Cohort 
Validation Description
Academic Period End/Start Date cannot be used in conjunction with Academic Period and vice versa.   
 
Admissions_Cohort_Open_On_Date  date  [0..1]  Open Date for Applications   
Admissions_Cohort_Close_Date  date  [0..1]  Close Date for the Admissions Cohort   
Application_Received_Deadline_Date  date  [0..1]  The deadline date for receiving applications.   
Admissions_Cohort_Materials_Due_Date  date  [0..1]  Due Date for Admissions Cohort Materials   
Application_Decision_Deadline_Date  date  [0..1]  The deadline date for application decisions.   
Application_Decision_Published_Deadline_Date  date  [0..1]  The deadline date for application decisions to be published.   
Application_Decision_Response_Deadline_Date  date  [0..1]  The deadline date for application responses.   
Admissions_Counselor_Reference  Admissions_CounselorObject  [1..1]  The Owner of the Admissions Cohort and its default Application Pool.   
Admission_Cohort_Application_Pool_Data  Admission_Cohort_Application_Pool_Data  [0..*]  Application Pool Data for the Admissions Cohort 
Validation Description
One of the Selected Admissions Counselors is Inactive.   
An existing Student Application Pool cannot be moved from a different Cohort.   
You may not add a condition rule type eligibility rule to an application pool.   
 
Validation Description
Select a unique combination of Academic Level, Academic Unit and academic period. For dynamic periods, the start and end dates can't overlap dates for existing cohorts.   
Enter a Materials Due By date that is on or after the Applications Received By date.   
Enter an Admission Responses Received By date that is on or after the Decisions Published By date.   
Enter a Decisions Published By date that is on or after the Decisions Rendered By date.   
Enter a Decisions Rendered By date that is on or after the Materials Due Date.   
Enter a Cohort Name that isn't already in use.   
Selected Admissions Counselor is Inactive   
Add Only is False and data other than the editable fields was changed.   
The Academic Period must be valid for the selected Academic Unit and Academic Level.   
Cannot create Dynamic Admissions Cohort for Fixed only Academic Unit Configuration.   
top
 

Academic_Curricular_Division_Subedit_Data

part of: Admissions_Cohort_Data
Contains Academic Unit information for a Student Prospect
 
Parameter name Type/Value Cardinality Description Validations
Academic_Level_Reference  Academic_LevelObject  [1..1]  References an Academic Level for a Student Prospect   
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  References an Academic Unit for a Student Prospect 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
top
 

Academic_LevelObject

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

Academic_Curricular_DivisionObject

part of: Academic_Curricular_Division_Subedit_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_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
 

Academic_Periods_Subedit_Data

part of: Admissions_Cohort_Data
Contains Academic Periods information for an Admissions Cohort
 
Parameter name Type/Value Cardinality Description Validations
Academic_Period_Reference  Academic_PeriodObject  [0..*]  References a set of Academic Periods for an Admissions Cohort   
Academic_Period_Start_Date  date  [0..1]  References an Academic Period Start Date for an Admissions Cohort 
Validation Description
Enter an Academic End Date that is after the Academic Start Date.   
You must enter an Academic Period Start Date if the Academic Period End Date is in use.   
 
Academic_Period_End_Date  date  [0..1]  References an Academic Period End Date for an Admissions Cohort   
Validation Description
Academic Period End/Start Date cannot be used in conjunction with Academic Period and vice versa.   
top
 

Academic_PeriodObject

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

Admissions_CounselorObject

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

Admissions_CounselorObjectID

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

Admission_Cohort_Application_Pool_Data

part of: Admissions_Cohort_Data
Contains data for the Admission Cohort's Applications Pools.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the Student Application Pool.   
Student_Application_Pool_Reference  Student_Application_PoolObject  [0..1]  References a Student Application Pool connected to the Admissions Cohort.   
Order  string  [1..1]  The order for the Student Application Pool   
Application_Pool_Name  string  [1..1]  The name of the Student Application Pool.   
Eligibility_Rule_Reference  Student_Eligibility_RuleObject  [1..1]  The Student Eligibility Rule for the Application Pool   
Admissions_Counselor_Reference  Admissions_CounselorObject  [1..*]  End of the range. The first letter of last name   
Validation Description
One of the Selected Admissions Counselors is Inactive.   
An existing Student Application Pool cannot be moved from a different Cohort.   
You may not add a condition rule type eligibility rule to an application pool.   
top
 

Student_Application_PoolObject

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

Student_Application_PoolObjectID

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

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

Student_Eligibility_RuleObjectID

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

Admissions_CohortReferenceEnumeration

part of: Admissions_CohortObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Admissions_CounselorReferenceEnumeration

part of: Admissions_CounselorObjectID
Base Type
string
top
 

Student_Application_PoolReferenceEnumeration

part of: Student_Application_PoolObjectID
Base Type
string
top
 

Student_Eligibility_RuleReferenceEnumeration

part of: Student_Eligibility_RuleObjectID
Base Type
string
top