Service Directory > v32.1 > Human_Resources > Get_Academic_Ranks
 

Operation: Get_Academic_Ranks

Get Academic Rank Web Service


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

Request element for Get Academic Rank
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Academic_Rank_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Academic_Rank_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Academic_Ranks_Response

Response Element for Get Academic Unit
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Academic_Rank_Request_References  [0..1]  Request References   
Request_Criteria  Academic_Rank_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Response results for Get Academic Rank Web Service   
Response_Data  Academic_Rank_Response_Data  [0..1]  Container for all the detail information about the Academic Rank   
top
 

Academic_Rank_Request_References

part of: Get_Academic_Ranks_Request, Get_Academic_Ranks_Response
Request References
 
Parameter name Type/Value Cardinality Description Validations
Academic_Rank_Reference  Academic_RankObject  [1..*]  Academic Rank Reference   
top
 

Academic_RankObject

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

Academic_RankObjectID

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

part of: Get_Academic_Ranks_Request, Get_Academic_Ranks_Response
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Academic_Ranks_Request, Get_Academic_Ranks_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_Ranks_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_Rank_Response_Data

part of: Get_Academic_Ranks_Response
Container for all the detail information about the Academic Rank
 
Parameter name Type/Value Cardinality Description Validations
Academic_Rank  Academic_Rank  [0..*]  Academic Rank Element   
top
 

Academic_Rank

part of: Academic_Rank_Response_Data
Academic Rank Element
 
Parameter name Type/Value Cardinality Description Validations
Academic_Rank_Reference  Academic_RankObject  [0..1]  Academic Rank Reference   
Academic_Rank_Data  Academic_Rank_Data  [0..1]  Container for all the detail information about the Academic Rank   
top
 

Academic_Rank_Data

part of: Academic_Rank
Container for all the detail information about the Academic Rank
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  A Reference ID for the Academic Rank generated by Workday and used for internal purposes only   
Academic_Rank_Title_Name  string  [1..1]  The Name of the Academic Rank   
Description  string  [0..1]  The description of the Academic Rank   
Emeritus  boolean  [0..1]  Academic Rank Emeritus Status   
Rank_Order  decimal (3, 0) >0   [0..1]  Academic Rank Order   
Job_Profile_Reference  Job_ProfileObject  [0..*]  Job Profiles to be associated with the Academic Rank 
Validation Description
The Job Profile selected is inactive. Please choose another Job Profile.  Validation Error: Occurs when Job Profile that is selected is inactive 
 
Metadata_Academic_Rank_Reference  Academic_Rank_MappingObject  [0..1]  Metadata Academic Rank Reference   
Inactive  boolean  [0..1]  Indicates whether or not the Academic Rank is considered Inactive. If set, the static text (inactive) will be appended to the Academic Rank's default display ID (Academic Rank Name).   
top
 

Job_ProfileObject

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

Job_ProfileObjectID

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

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

Academic_Rank_MappingObjectID

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

part of: Academic_RankObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

Academic_Rank_MappingReferenceEnumeration

part of: Academic_Rank_MappingObjectID
Base Type
string
top