Service Directory > v25.1 > Academic_Foundation > Get_Programs_of_Study
 

Operation: Get_Programs_of_Study

Returns Programs of Study based on Code and Effective Date, or returns all instances of Programs of Study if no criteria is specified. Only values that are effective as of the specified Effective Date will be returned.


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

Wrapper element for Programs of Study Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Program_of_Study_Request_References  [0..1]  Element containing the list of Programs of Study for which data is requested.   
Request_Criteria [Choice]   Program_of_Study_Request_Criteria  [0..1]  Utilize the following criteria options to search for Programs of Study within the Workday system.   
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_Programs_of_Study_Response

Programs of Study data returned by Get Programs of Study Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Program_of_Study_Request_References  [0..1]  Element containing the list of Programs of Study for which data is requested.   
Request_Criteria  Program_of_Study_Request_Criteria  [0..1]  Utilize the following criteria options to search for Programs of Study within the Workday system.   
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  Program_of_Study_Response_Data  [0..1]  Wrapper element for the Program of Study data.   
top
 

Program_of_Study_Request_References

part of: Get_Programs_of_Study_Request, Get_Programs_of_Study_Response
Element containing the list of Programs of Study for which data is requested.
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study_Reference  Program_of_StudyObject  [1..*]  Workset of Programs of Study for which data is requested.   
top
 

Program_of_StudyObject

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

Program_of_StudyObjectID

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

Program_of_Study_Request_Criteria

part of: Get_Programs_of_Study_Request, Get_Programs_of_Study_Response
Utilize the following criteria options to search for Programs of Study within the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study_Code  string  [0..1]  Search by Program of Study Code   
Effective_Date  date  [0..1]  Search by Program of Study Effective Date   
top
 

Response_Filter

part of: Get_Programs_of_Study_Request, Get_Programs_of_Study_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_Programs_of_Study_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
 

Program_of_Study_Response_Data

part of: Get_Programs_of_Study_Response
Wrapper element for the Program of Study data.
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study  Program_of_Study  [0..*]  Wrapper element for the Program of Study data.   
top
 

Program_of_Study

part of: Program_of_Study_Response_Data
Wrapper element for the Program of Study data.
 
Parameter name Type/Value Cardinality Description Validations
Program_of_Study_Reference  Program_of_StudyObject  [0..1]  Program of Study Reference   
Program_of_Study_Data  Program_of_Study_Data  [1..1]  Wrapper element for the Program of Study data. 
Validation Description
An Educational Credential cannot be entered this non-credential granting Program of Study.   
At least one Educational Credential must be entered for this credential granting Program of Study.   
A Program Concentration cannot be required for a non-concentration possible Program of Study.   
Enter at least 1 Program Concentration or clear the Program Concentration Required check box.   
A Program Concentration cannot be entered for this non-concentration possible Program of Study.   
Enter a First Entry Date that is on or after the Effective Date.   
Enter a Last Entry Date that is on or after the First Entry Date.   
Effective Date must be on or after the Academic Unit Effective Date.   
Enter a First Entry Date that is on or after the first entry date for the academic unit and level.   
Enter a First Entry Date that is before the Last Entry Date for the academic unit.   
The Academic Unit must be configured for this Academic Level.   
All Locations must have Campus as their usage type.   
 
top
 

Program_of_Study_Data

part of: Program_of_Study
Wrapper element for the Program of Study data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Program of Study Data   
Effective_Date  date  [1..1]  Program of Study Effective Date   
Program_of_Study_Type_Reference  Program_of_Study_TypeObject  [1..1]  Program of Study Type Reference   
Program_of_Study_Code  string  [1..1]  Program of Study Code 
Validation Description
Enter a Program of Study Code that isn't already in use.   
 
Program_Name  string  [1..1]  Program of Study Name   
CIP_Code_Reference  CIP_Code__Workday_Owned_Object  [0..1]  CIP Code for Program of Study   
Educational_Taxonomy_Code_Reference  Educational_Taxonomy_CodeObject  [0..1]  Educational Taxonomy Code for Program of Study   
Allowed_Locations_Reference  LocationObject  [0..*]  Allowed Locations for Program of Study   
Fast_Path_Enabled  boolean  [0..1]  Program of Study Fast Path Enabled   
Include_Type_in_Name  boolean  [0..1]  Include Type in Name   
First_Entry_Date  date  [1..1]  First Entry Date   
Last_Entry_Date  date  [0..1]  Last Entry Date   
Academic_Level_Reference  Academic_LevelObject  [1..1]  Academic Level Reference   
Academic_Unit_Reference  Academic_UnitObject  [1..1]  Academic Unit Reference 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Program_Concentration_Required  boolean  [0..1]  Program Concentration Required   
Educational_Credentials_Reference  Educational_CredentialObject  [0..*]  Educational Credentials Reference   
Program_of_Study_Data_Program_Concentration_Subedit  Program_of_Study_Data_Program_Concentration_Subedit  [0..*]  Program Concentration data for Program of Study   
Validation Description
An Educational Credential cannot be entered this non-credential granting Program of Study.   
At least one Educational Credential must be entered for this credential granting Program of Study.   
A Program Concentration cannot be required for a non-concentration possible Program of Study.   
Enter at least 1 Program Concentration or clear the Program Concentration Required check box.   
A Program Concentration cannot be entered for this non-concentration possible Program of Study.   
Enter a First Entry Date that is on or after the Effective Date.   
Enter a Last Entry Date that is on or after the First Entry Date.   
Effective Date must be on or after the Academic Unit Effective Date.   
Enter a First Entry Date that is on or after the first entry date for the academic unit and level.   
Enter a First Entry Date that is before the Last Entry Date for the academic unit.   
The Academic Unit must be configured for this Academic Level.   
All Locations must have Campus as their usage type.   
top
 

Program_of_Study_TypeObject

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

Program_of_Study_TypeObjectID

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

CIP_Code__Workday_Owned_Object

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

CIP_Code__Workday_Owned_ObjectID

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

Educational_Taxonomy_CodeObject

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

Educational_Taxonomy_CodeObjectID

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

LocationObject

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

LocationObjectID

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

part of: Program_of_Study_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_UnitObject

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

Academic_UnitObjectID

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

Educational_CredentialObject

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

Educational_CredentialObjectID

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

Program_of_Study_Data_Program_Concentration_Subedit

part of: Program_of_Study_Data
Wrapper element for Program Concentration data
 
Parameter name Type/Value Cardinality Description Validations
Program_Concentration_Reference  Program_ConcentrationObject  [0..1]  The subelement containing Program Concentration data. 
Validation Description
The Program Concentration entered is owned by another Program of Study.   
A Program of Study Reference or ID is required to pass in a Program Concentration ID reference.   
 
ID  string  [0..1]  Program Concentration Reference ID   
Program_Concentration_Name  string  [1..1]  Program Concentration Name 
Validation Description
Enter a Concentration Name that isn't already in use.  Program Concentration Names must be unique 
 
CIP_Code_Reference  CIP_Code__Workday_Owned_Object  [0..1]  CIP Code for Program Concentration   
Educational_Taxonomy_Code_Reference  Educational_Taxonomy_CodeObject  [0..1]  Educational Taxonomy Code for Program Concentration   
top
 

Program_ConcentrationObject

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

Program_ConcentrationObjectID

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

Program_of_StudyReferenceEnumeration

part of: Program_of_StudyObjectID
Base Type
string
top
 

Program_of_Study_TypeReferenceEnumeration

part of: Program_of_Study_TypeObjectID
Base Type
string
top
 

CIP_Code__Workday_Owned_ReferenceEnumeration

part of: CIP_Code__Workday_Owned_ObjectID
Base Type
string
top
 

Educational_Taxonomy_CodeReferenceEnumeration

part of: Educational_Taxonomy_CodeObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Educational_CredentialReferenceEnumeration

part of: Educational_CredentialObjectID
Base Type
string
top
 

Program_ConcentrationReferenceEnumeration

part of: Program_ConcentrationObjectID
Base Type
string
top