Service Directory > v31.2 > Academic_Foundation > Get_Maintained_Academic_Periods
 

Operation: Get_Maintained_Academic_Periods

Retrieves Academic Periods by Reference ID, or returns all Academic Periods if no Reference IDs are specified.


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

Wrapper element for Maintained Academic Periods Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Academic_Period_Request_References  [0..1]  Wrapper element for Academic Period Request Reference   
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_Maintained_Academic_Periods_Response

Wrapper element for the Academic Period returned as a result of a Get Maintained Academic Periods request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Academic_Period_Request_References  [0..1]  Wrapper element for Academic Period Request Reference   
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  Maintained_Academic_Period_Response_Data  [0..1]  Wrapper element for the Maintained Academic Period Response data.   
top
 

Academic_Period_Request_References

part of: Get_Maintained_Academic_Periods_Request, Get_Maintained_Academic_Periods_Response
Wrapper element for Academic Period Request Reference
 
Parameter name Type/Value Cardinality Description Validations
Academic_Period_Reference  Academic_PeriodObject  [1..*]  Academic Period Reference   
top
 

Academic_PeriodObject

part of: Academic_Period_Request_References, Maintained_Academic_Period
 
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
 

Response_Filter

part of: Get_Maintained_Academic_Periods_Request, Get_Maintained_Academic_Periods_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_Maintained_Academic_Periods_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
 

Maintained_Academic_Period_Response_Data

part of: Get_Maintained_Academic_Periods_Response
Wrapper element for the Maintained Academic Period Response data.
 
Parameter name Type/Value Cardinality Description Validations
Maintained_Academic_Period  Maintained_Academic_Period  [0..*]  Wrapper element for the Maintained Academic Period data.   
top
 

Maintained_Academic_Period

part of: Maintained_Academic_Period_Response_Data
Wrapper element for the Maintained Academic Period data.
 
Parameter name Type/Value Cardinality Description Validations
Academic_Period_Reference  Academic_PeriodObject  [0..1]  Academic Period Reference   
Maintained_Academic_Period_Data  Maintained_Academic_Period_Data  [0..*]  Wrapper element for the Maintained Academic Period data. 
Validation Description
End Date is before Start Date.   
Standard Start and End Dates are required if the Academic Period Type is Standard.   
Standard Academic Period Start Date is not editable.   
Standard Academic Period End Date is not editable.   
 
top
 

Maintained_Academic_Period_Data

part of: Maintained_Academic_Period
Wrapper element for the Maintained Academic Period data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the Academic Period   
Academic_Period_Name  string  [1..1]  Academic Period Name   
Academic_Period_Type_Reference  Academic_Period_TypeObject  [0..1]  Academic Period Type   
Standard_Start_Date  date  [0..1]  Standard Start Date 
Validation Description
Standard Start Date is required for Standard Academic Periods.   
Cannot set Standard Start Date for a non-Standard Academic Period.   
Enter a Start Date on or after Standard Start Date.   
 
Academic_Period_Start_Date  date  [1..1]  Academic Period Start Date   
Academic_Period_End_Date  date  [1..1]  Academic Period End Date   
Standard_End_Date  date  [0..1]  Standard End Date 
Validation Description
The End Date of the Period cannot be after the Standard End Date.   
Standard End Date is required for Standard Academic Periods.   
Cannot set Standard End Date for non-Standard Academic Periods.   
 
Display_Date_Range  boolean  [0..1]  If checked, date range is displayed   
Academic_Period_Weeks_of_Instruction  decimal (12, 0) >0   [0..1]  Academic Period Weeks of Instruction 
Validation Description
Academic Periods having Academic Usage require nonzero Weeks of Instruction.   
 
Academic_Period_Usage_Reference  Academic_Period_UsageObject  [0..*]  Academic Period Usage Reference 
Validation Description
Academic Periods for Activity Pay must have at most one Academic Year   
 
Inactive  boolean  [0..1]  Inactive flag   
Academic_Period_Weight_Data  Academic_Period_Weight_Data  [0..*]  Wrapper element for the Maintained Academic Period data.   
Academic_Period_Date_Control_Data  Academic_Period_Date_Control_Data  [0..*]  Wrapper element for the Academic Period Date Controls data.   
Validation Description
End Date is before Start Date.   
Standard Start and End Dates are required if the Academic Period Type is Standard.   
Standard Academic Period Start Date is not editable.   
Standard Academic Period End Date is not editable.   
top
 

Academic_Period_TypeObject

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

Academic_Period_TypeObjectID

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

Academic_Period_UsageObject

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

Academic_Period_UsageObjectID

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

part of: Maintained_Academic_Period_Data
Wrapper element for the Maintained Academic Period data.
 
Parameter name Type/Value Cardinality Description Validations
Academic_Period_Weight_Reference  Academic_Period_WeightObject  [0..1]  Academic Period Weight Reference   
Academic_Period_Weight_Type_Reference  Academic_Period_Weight_TypeObject  [1..1]  Academic Period Weight Type Reference   
Academic_Period_Weight_Value  decimal (4, 2) >0   [0..1]  Academic Period Weight Value   
top
 

Academic_Period_WeightObject

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

Academic_Period_WeightObjectID

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

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

Academic_Period_Weight_TypeObjectID

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

Academic_Period_Date_Control_Data

part of: Maintained_Academic_Period_Data
Wrapper Element for Maintained Academic Period Data
 
Parameter name Type/Value Cardinality Description Validations
Academic_Period_Date_Control_Time_Zone_Reference  Time_ZoneObject  [1..1]  Academic Period Date Control Time Zone Reference   
Academic_Period_Date_Control_Subedit_Data  Academic_Period_Date_Control_Subedit_Data  [0..*]  Academic Period Date Control Subedit Data 
Validation Description
Cannot have both Academic Period Control Date Use Course Section Start set to true and the Academic Period Control Date specified.   
Enrollment Window Start and Enrollment Window End Date Controls cannot use Course Section Start   
A Date Control may only have one date for an academic period.   
You must also enter a corresponding Registration Soft Drop Window End Date   
You must also enter a corresponding Registration Soft Drop Window Start Date   
Cannot use an Academic Period Control Date for another Academic Period.   
Must specify either Use Course Section Start or an Academic Period Control Date.   
 
top
 

Time_ZoneObject

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

Time_ZoneObjectID

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

part of: Academic_Period_Date_Control_Data
Wrapper element for the Academic Period Date Control data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Academic Period Date Control Reference   
Date_Control_Reference  Date_ControlObject  [1..1]  Date Control Reference   
Use_Course_Section_Start  boolean  [0..1]  Use Course Section Start Reference   
Control_Date  dateTime  [0..1]  Control Date Reference   
Validation Description
Cannot have both Academic Period Control Date Use Course Section Start set to true and the Academic Period Control Date specified.   
Enrollment Window Start and Enrollment Window End Date Controls cannot use Course Section Start   
A Date Control may only have one date for an academic period.   
You must also enter a corresponding Registration Soft Drop Window End Date   
You must also enter a corresponding Registration Soft Drop Window Start Date   
Cannot use an Academic Period Control Date for another Academic Period.   
Must specify either Use Course Section Start or an Academic Period Control Date.   
top
 

Date_ControlObject

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

Date_ControlObjectID

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

part of: Academic_PeriodObjectID
Base Type
string
top
 

Academic_Period_TypeReferenceEnumeration

part of: Academic_Period_TypeObjectID
Base Type
string
top
 

Academic_Period_UsageReferenceEnumeration

part of: Academic_Period_UsageObjectID
Base Type
string
top
 

Academic_Period_WeightReferenceEnumeration

part of: Academic_Period_WeightObjectID
Base Type
string
top
 

Academic_Period_Weight_TypeReferenceEnumeration

part of: Academic_Period_Weight_TypeObjectID
Base Type
string
top
 

Time_ZoneReferenceEnumeration

part of: Time_ZoneObjectID
Base Type
string
top
 

Date_ControlReferenceEnumeration

part of: Date_ControlObjectID
Base Type
string
top