Service Directory > v31.2 > Student_Recruiting > Put_Student_Recruiting_Cycle
 

Operation: Put_Student_Recruiting_Cycle

Creates a new Student Recruiting Cycle (or updates an existing Student Recruiting Cycle) with the information supplied in the request.


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

Wrapper element for the Put Student Recruiting Cycle 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.   
Student_Recruiting_Cycle_Reference  Student_Recruiting_CycleObject  [0..1]  The reference to the Student Recruiting Cycle being updated. For new Student Recruiting Cycles, this element will not exist.   
Student_Recruiting_Cycle_Data  Student_Recruiting_Cycle_Data  [1..1]  Contains Student Recruiting Cycle Data   
Validation Description
The Web Service is set to Add Only; but the Student Recruiting Cycle already exists.   
top
 

Response Element: Put_Student_Recruiting_Cycle_Response

Wrapper element for the Put Student Recruiting Cycle Returned data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Recruiting_Cycle_Reference  Student_Recruiting_CycleObject  [0..1]  The reference to the Student Recruiting Cycle which was added or updated.   
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [0..1]  References an Academic Unit for a Student Recruiting Cycle   
top
 

Student_Recruiting_CycleObject

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

Student_Recruiting_CycleObjectID

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

part of: Put_Student_Recruiting_Cycle_Request
Wrapper element for the Student Recruiting Cycle data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Student Recruiting Cycle Data   
Name  string  [1..1]  Student Recruiting Cycle Name. 
Validation Description
Enter a Name that isn't already in use.   
 
Academic_Unit_Subedit_Data  Has_Academic_Curricular_Division_Data  [1..*]  Wrapper element for the Has Academic Unit Data which contains an Academic Unit and Academic Level 
Validation Description
Academic Level is required.   
Only a single academic level is allowed.   
The Academic Unit is not valid for the selected Academic Level.   
 
Academic_Date_Range_Reference  Academic_Date_RangeObject  [1..1]  References the academic date range for a cycle   
Description  RichText  [0..1]  References a Description for a Student Recruiting Cycle   
top
 

Has_Academic_Curricular_Division_Data

part of: Student_Recruiting_Cycle_Data
Wrapper element for the Has Academic Unit Data which contains an Academic Unit and Academic Level
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  Academic Unit 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Academic_Level_Reference  Academic_LevelObject  [0..*]  Academic Level Nonsingular Workset   
Validation Description
Academic Level is required.   
Only a single academic level is allowed.   
The Academic Unit is not valid for the selected Academic Level.   
top
 

Academic_Curricular_DivisionObject

part of: Put_Student_Recruiting_Cycle_Response, Has_Academic_Curricular_Division_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_LevelObject

part of: Has_Academic_Curricular_Division_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_Date_RangeObject

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

Academic_Date_RangeObjectID

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

part of: Student_Recruiting_CycleObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Academic_Date_RangeReferenceEnumeration

part of: Academic_Date_RangeObjectID
Base Type
string
top
 

RichText

part of: Student_Recruiting_Cycle_Data
Base Type
string
top