Service Directory > v32.1 > Human_Resources > Get_Period_Reporting_Calendars
 

Operation: Get_Period_Reporting_Calendars

Retrieves the information about the Period Reporting Calendars requested


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

Request element for Get Period Reporting Calendars
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Period_Reporting_Calendar_Request_References  [0..1]  Request References Element for Get Period Reporting Calendars Web Service   
Request_Criteria [Choice]   Period_Reporting_Calendar_Request_Criteria  [0..1]  The Criteria of the request   
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_Group  Period_Reporting_Calendar_Response_Group  [0..1]  the specified response group of the request   
top
 

Response Element: Get_Period_Reporting_Calendars_Response

Response Element for Get Period Reporting Calendar
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Period_Reporting_Calendar_Request_References  [0..1]  Request References element for Get Period Reporting Calendars Web Service   
Request_Criteria  Period_Reporting_Calendar_Request_Criteria  [0..1]  Request Criteria for Get Period Reporting Calendars Web Service   
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_Group  Period_Reporting_Calendar_Response_Group  [0..1]  Response Group for Get Period Reporting Calendars Web Service   
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  Period_Reporting_Calendar_Response_Data  [0..1]  Response element for Get Period Reporting Calendars Web Service   
top
 

Period_Reporting_Calendar_Request_References

part of: Get_Period_Reporting_Calendars_Request, Get_Period_Reporting_Calendars_Response
Request References Element for Get Period Reporting Calendars Web Service
 
Parameter name Type/Value Cardinality Description Validations
Period_Reporting_Calendar_Reference  Period_Reporting_CalendarObject  [1..*]  Period Reporting Calendars being requested   
top
 

Period_Reporting_CalendarObject

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

Period_Reporting_CalendarObjectID

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

Period_Reporting_Calendar_Request_Criteria

part of: Get_Period_Reporting_Calendars_Request, Get_Period_Reporting_Calendars_Response
Request Criteria of the Period Reporting Calendar
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Period_Reporting_Calendars_Request, Get_Period_Reporting_Calendars_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
 

Period_Reporting_Calendar_Response_Group

part of: Get_Period_Reporting_Calendars_Request, Get_Period_Reporting_Calendars_Response
Response Group of the Period Reporting Calendar Web Service
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference flag for the Get Period Reporting Calendars Web Service   
top
 

Response_Results

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

Period_Reporting_Calendar_Response_Data

part of: Get_Period_Reporting_Calendars_Response
Response element for Get Period Reporting Calendars Web Service
 
Parameter name Type/Value Cardinality Description Validations
Period_Reporting_Calendar  Period_Reporting_Calendar  [0..*]  Wrapper Element for Responding with Reporting Calendar Data   
top
 

Period_Reporting_Calendar

part of: Period_Reporting_Calendar_Response_Data
Wrapper Element for Responding with Reporting Calendar Data
 
Parameter name Type/Value Cardinality Description Validations
Period_Reporting_Calendar_Reference  Period_Reporting_CalendarObject  [0..1]  Reference for Period Reporting Calendar   
Period_Reporting_Calendar_Data  Period_Reporting_Calendar_Data  [0..*]  Period Reporting Calendar Data element (Contains all the information about a period reporting calendar)   
top
 

Period_Reporting_Calendar_Data

part of: Period_Reporting_Calendar
Form to put, update, and view a Period Reporting Calendar
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID of the Period Reporting Calendar   
Reporting_Calendar_Name  string  [1..1]  Period Reporting Calendar Name   
Academic_Unit_Reference  Academic_UnitObject  [0..*]  The Academic Units the Period Reporting Calendar is restricted to   
Default_Calendar  boolean  [0..1]  If true, the Period Reporting calendar is the default for the system or the academic unit 
Validation Description
You can't select the Default Calendar check box because the [calendar name] period reporting calendar is already defined as the default. To make this calendar the default, clear the check box on the other one.   
You can't select the Default Calendar check box because the [calendar name] period reporting calendar is already defined as the default. To make this calendar the default, clear the check box on the other one.   
An inactive Calendar cannot be designated as the Default.   
 
Inactive  boolean  [0..1]  if true, the Period Reporting Calendar is inactive   
Period_Reporting_Calendar_Row_Data  Period_Reporting_Calendar_Row_Data  [0..*]  Data per Period of the Period Reporting Calendar 
Validation Description
Add Only is set to true. You can not submit a reference to update. Please remove the Add Only flag for updating.   
Enter the Period Reporting Calendar Row Reference for the reporting period row you want to delete.   
 
top
 

Academic_UnitObject

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

Period_Reporting_Calendar_Row_Data

part of: Period_Reporting_Calendar_Data
Period Reporting Row Data
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  States that this row is to be deleted   
@Add_Only  boolean  [1..1]  Determines if this row is a new row to add   
Order  string (6)   [1..1]  The order this period has   
ID  string  [0..1]  Reference ID of the Period Reporting Calendar Row   
Calendar_Period_Name  string  [1..1]  The Name of the Period. 
Validation Description
Name for the Calendar Row must be unique within the Calendar   
 
Academic_Period_Reference  Academic_PeriodObject  [0..1]  The academic period associated with this period row. (Is Optional!) 
Validation Description
For row # [order], the Academic Period's assigned Academic Unit must match the Calendar's Restricted to Academic Unit   
 
Start_Date  date  [1..1]  The Start Date of the evaluation period   
End_Date  date  [1..1]  The End Date of the evaluation period 
Validation Description
End Date must be after or on Start Date   
 
Evaluation_Constraint_Reference  Evaluation_ConstraintObject  [1..1]  The specification of how the status of a period is calculated based on the date range   
Validation Description
Add Only is set to true. You can not submit a reference to update. Please remove the Add Only flag for updating.   
Enter the Period Reporting Calendar Row Reference for the reporting period row you want to delete.   
top
 

Academic_PeriodObject

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

Evaluation_ConstraintObject

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

Evaluation_ConstraintObjectID

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

Period_Reporting_CalendarReferenceEnumeration

part of: Period_Reporting_CalendarObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Evaluation_ConstraintReferenceEnumeration

part of: Evaluation_ConstraintObjectID
Base Type
string
top