Service Directory > v31.2 > Human_Resources > Get_Academic_Appointment_Track_Additional_Data
 

Operation: Get_Academic_Appointment_Track_Additional_Data

Retrieves effective-dated additional data for the specified Academic Appointment Tracks or for all Academic Appointment Tracks if none were specified. Use the effective response filter to specify the effective date, otherwise additional data as of the current system time will be retrieved.


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

Contains request reference, criteria, and filter for getting Academic Track Additional data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Academic_Appointment_Track_Additional_Data_Request_References  [0..1]  Academic Appointment Track Reference   
Request_Criteria [Choice]   Academic_Appointment_Track_Additional_Data_Request_Criteria  [0..1]  Request criteria   
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_Academic_Appointment_Track_Additional_Data_Response

Wrapper element containing Academic Appointment Track Additional Data for requested references or criteria.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Academic_Appointment_Track_Additional_Data_Request_References  [0..1]  Academic Appointment Track References to view Additional Data   
Request_Criteria  Academic_Appointment_Track_Additional_Data_Request_Criteria  [0..1]  Academic Appointment Track Additional Data request criteria   
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  Academic_Appointment_Track_Additional_Data_Response_Data  [0..1]  Contains the effective-dated additional data for the requested Academic Appointment Tracks as of the effective date.   
top
 

Academic_Appointment_Track_Additional_Data_Request_References

part of: Get_Academic_Appointment_Track_Additional_Data_Request, Get_Academic_Appointment_Track_Additional_Data_Response
Academic Appointment Track References to view Additional Data
 
Parameter name Type/Value Cardinality Description Validations
Academic_Appointment_Track_Reference  Academic_Appointment_TrackObject  [1..*]  Academic Appointment Track reference.   
top
 

Academic_Appointment_TrackObject

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

Academic_Appointment_TrackObjectID

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

part of: Get_Academic_Appointment_Track_Additional_Data_Request, Get_Academic_Appointment_Track_Additional_Data_Response
Academic Appointment Track Additional Data request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Academic_Appointment_Track_Additional_Data_Request, Get_Academic_Appointment_Track_Additional_Data_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_Academic_Appointment_Track_Additional_Data_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
 

Academic_Appointment_Track_Additional_Data_Response_Data

part of: Get_Academic_Appointment_Track_Additional_Data_Response
Contains the effective-dated additional data for the requested Academic Appointment Tracks as of the effective date.
 
Parameter name Type/Value Cardinality Description Validations
Academic_Appointment_Track_Additional_Data  Academic_Appointment_Track_Custom_Object_Data  [0..*]  Effective dated additional data for an Academic Appointment Track. When updating custom objects that allow multiple instances, data for existing instances must appear in the request, otherwise it will be removed. 
Validation Description
The effective date must be between the Appointment Track’s Start Date and End Date.   
 
top
 

Academic_Appointment_Track_Custom_Object_Data

part of: Academic_Appointment_Track_Additional_Data_Response_Data
Effective dated additional data for an Academic Appointment Track. When updating custom objects that allow multiple instances, data for existing instances must appear in the request, otherwise it will be removed.
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  Effective date of the edit additional data request.   
Academic_Appointment_Track_Reference  Academic_Appointment_TrackObject  [1..1]  Academic Appointment Track for edit additional data request.   
Business_Object_Additional_Data  Effective_Dated_Web_Service_Additional_Data  [1..1]  Web Service Additional Data   
Validation Description
The effective date must be between the Appointment Track’s Start Date and End Date.   
top
 

Effective_Dated_Web_Service_Additional_Data

part of: Academic_Appointment_Track_Custom_Object_Data
Web Service Additional Data
 
Parameter name Type/Value Cardinality Description Validations
top
 

Academic_Appointment_TrackReferenceEnumeration

part of: Academic_Appointment_TrackObjectID
Base Type
string
top