Service Directory > v32.1 > Academic_Foundation > Put_Program_of_Study
 

Operation: Put_Program_of_Study

Creates a new Programs of Study (or updates an existing Program of Study) with the information supplied in the request. If a reference ID is provided with a new Effective Date, a new Program of Study snapshot will be created with the effective dated fields.


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

Wrapper element for the Put Program of Study Request Information.
 
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.   
Program_of_Study_Reference  Program_of_StudyObject  [0..1]  The reference to the Program of Study being updated. For new Programs of Study , this element will not exist.   
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 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.   
Primary Program of Study must be different from Secondary Program of Study.   
Selected Program Areas cannot share the same Program Area Type.   
Ensure that this Program of Study is owned by an Academic Unit with a superior Institution.   
Only one of the following may be input: Financial Aid Criteria Program Weeks, Months, Years   
Program of Study must specify a Program Duration.   
You must make admissions response not required for Fast Path programs of study.   
A Calendar Policy must be explicitly defined on this Program of Study in order to change the Owning Academic Unit or Academic Level.   
To submit this program of study, ensure that the parent program of study is of a type that’s configured for Concentration Possible.   
 
Validation Description
The Web Service is set to Add Only, but the Program of Study already exists.   
top
 

Response Element: Put_Program_of_Study_Response

Response for the Put Program of Study Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Program_of_Study_Reference  Program_of_StudyObject  [0..1]  The reference of the Program of Study that was added or updated.   
top
 

Program_of_StudyObject

part of: Program_of_Study_Data, Program_of_Study_Data, Program_of_Study_Data, Put_Program_of_Study_Request, Put_Program_of_Study_Response, Program_of_Study_Addable_Configuration_Data, Program_of_Study_Addable_Configuration_Data, Program_of_Study_Addable_Configuration_Data, Program_of_Study_Addable_Configuration_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_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_Data

part of: Put_Program_of_Study_Request
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 
Validation Description
The new Program Type must have the same Category and Credential Granting and Concentration Possible settings. Use the Maintain Program of Study Types task to view or change these details.   
 
Program_Duration_Weeks  decimal (12, 0) >0   [0..1]  Financial Aid Criteria Program Weeks   
Program_Duration_Months  decimal (12, 0) >0   [0..1]  Financial Aid Criteria Program Months   
Program_Duration_Years  decimal (12, 0) >0   [0..1]  Financial Aid Criteria Program Years   
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.   
 
Primary_Program_of_Study_Reference  Program_of_StudyObject  [0..1]  Primary Program of Study 
Validation Description
Primary and Secondary Program of Study is Required if the Program of Study Type Category is a Formalized Joint Program.   
Cannot Assign a Primary and Secondary Program of Study if Program of Study Type Category is not Formalized Joint Program.   
 
Secondary_Program_of_Study_Reference  Program_of_StudyObject  [0..1]  Secondary Program of Study   
Parent_Program_of_Study_Reference  Program_of_StudyObject  [0..1]  Parent Program of Study 
Validation Description
Parent Program of Study is required if the Program of Study Type Category is a Program Focus.   
Cannot assign a Parent Program of Study if the Program of Study Type Category is not a Program Focus.   
The Academic Units of the Program Focus and the Parent Program of Study must match.   
 
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 
Validation Description
The CIP Code for a Program of Study must have six digits.   
 
Educational_Taxonomy_Codes_Reference  Educational_Taxonomy_CodeObject  [0..*]  Educational Taxonomy Code for Program of Study   
Allowed_Locations_Reference  LocationObject  [0..*]  Allowed Locations for Program of Study   
Admission_Response_Not_Required  boolean  [0..1]  Program of Study Admission Response Not Required 
Validation Description
You can't set Admission Response Not Required to True for a Program Focus.   
 
Fast_Path_Enabled  boolean  [0..1]  Program of Study Fast Path Enabled 
Validation Description
Cannot set Fast Path Enabled to True for a Program Focus.   
 
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.   
 
Coordinating_Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  Coordinating Academic Unit 
Validation Description
The Coordinating Academic Unit must be the Owning Academic Unit or one of its Subordinate Academic Units.   
 
Program_Focus_Required  boolean  [0..1]  Program Focus Required   
Evaluate_Academic_Requirements_Prior_to_Program_Change  boolean  [0..1]  Evaluate Academic Requirements Prior to Program Change   
Program_Area_Reference  Program_AreaObject  [0..*]  Program Areas 
Validation Description
Program Areas of a Program Focus must match its Parent Program of Study.   
 
Educational_Credentials_Reference  Educational_CredentialObject  [0..*]  Educational Credentials Reference 
Validation Description
Cannot set Educational Credential for Program Foci.   
 
Addable_Configuration_Data  Program_of_Study_Addable_Configuration_Data  [0..*]  Addable Configuration data 
Validation Description
You can’t configure addable or stackable programs of study for a program of study that can’t be Primary.   
Validation Description
You can’t configure Stackable programs of study when the Program of Study Type belongs to the Formalized Joint Program category.   
You must specify one of these for addable programs of study: Include All, Include, or Exclude.   
You can only specify one of these for addable programs of study: Include All, Include, or Exclude.   
You can only specify one of these for stackable programs of study: Include All, Include, or Exclude.   
Select a unique combination of Academic Unit, Academic Level, and Program of Study Type for each row. When you leave the Academic Level and Program of Study Type blank, all levels and types in the selected Academic Unit apply.   
 
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 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.   
Primary Program of Study must be different from Secondary Program of Study.   
Selected Program Areas cannot share the same Program Area Type.   
Ensure that this Program of Study is owned by an Academic Unit with a superior Institution.   
Only one of the following may be input: Financial Aid Criteria Program Weeks, Months, Years   
Program of Study must specify a Program Duration.   
You must make admissions response not required for Fast Path programs of study.   
A Calendar Policy must be explicitly defined on this Program of Study in order to change the Owning Academic Unit or Academic Level.   
To submit this program of study, ensure that the parent program of study is of a type that’s configured for Concentration Possible.   
top
 

Program_of_Study_TypeObject

part of: Program_of_Study_Data, Program_of_Study_Addable_Configuration_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
 
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
 
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, Program_of_Study_Addable_Configuration_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, Program_of_Study_Addable_Configuration_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
 

Academic_Curricular_DivisionObject

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_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
 

Program_AreaObject

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

Program_AreaObjectID

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

part of: Program_of_Study_Data
The row defining an addable program of study configuration, including the Academic Unit, Academic Level(s), and Programs of Study Type(s) restricting the Programs of Study, and the Included/Excluded Addable and Stackable Programs of Study.
 
Parameter name Type/Value Cardinality Description Validations
Addable_Academic_Unit_Reference  Academic_UnitObject  [1..1]  Academic Unit Reference for an Addable Configuration 
Validation Description
The Academic Unit for the addable program must have the same Institution as the academic unit for the program of study.   
 
Addable_Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic Level Reference for an Addable Configuration   
Addable_Program_of_Study_Type_Reference  Program_of_Study_TypeObject  [0..*]  Program of Study Type Reference for an Addable Configuration   
Addable_Include_All  boolean  [0..1]  Include All Addable Programs of Study boolean   
Included_Addable_Reference  Program_of_StudyObject  [0..*]  Included Addable Programs of Study Reference 
Validation Description
You can only include programs of study as addable when they are within the Academic Unit, Academic Level, and Program of Study Type configuration you just selected.   
 
Excluded_Addable_Reference  Program_of_StudyObject  [0..*]  Excluded Addable Programs of Study Reference 
Validation Description
You can only exclude programs of study as addable when they are within the Academic Unit, Academic Level, and Program of Study Type configuration you just selected.   
 
Stackable_Include_All  boolean  [0..1]  Include All Stackable Programs of Study boolean   
Included_Stackable_Reference  Program_of_StudyObject  [0..*]  Included Stackable Programs of Study Reference 
Validation Description
You can only include or exclude a program of study as stackable when you include it as addable and it belongs to any of the standalone categories except Formalized Joint Program.   
 
Excluded_Stackable_Reference  Program_of_StudyObject  [0..*]  Excluded Stackable Programs of Study Reference 
Validation Description
You can only include or exclude a program of study as stackable when you include it as addable and it belongs to any of the standalone categories except Formalized Joint Program.   
 
Validation Description
You can’t configure Stackable programs of study when the Program of Study Type belongs to the Formalized Joint Program category.   
You must specify one of these for addable programs of study: Include All, Include, or Exclude.   
You can only specify one of these for addable programs of study: Include All, Include, or Exclude.   
You can only specify one of these for stackable programs of study: Include All, Include, or Exclude.   
Select a unique combination of Academic Unit, Academic Level, and Program of Study Type for each row. When you leave the Academic Level and Program of Study Type blank, all levels and types in the selected Academic Unit apply.   
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
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Program_AreaReferenceEnumeration

part of: Program_AreaObjectID
Base Type
string
top
 

Educational_CredentialReferenceEnumeration

part of: Educational_CredentialObjectID
Base Type
string
top