Service Directory > v23.0 > Performance_Management > Get_Degrees
 

Operation: Get_Degrees

This operation retrieves the educational degrees that are currently defined.


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

This element contains optional reference and filter criteria for the request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Degree_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Degree and its associated data.   
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_Degrees_Response

Response element for Get Degrees.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Degree_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Degree and its associated data.   
Response_Filter  Response_Filter  [0..1]  The "Response_Filter" element contains common WWS information that allows you control the response data that you will be provided including As_Of_Date, As_Of_Entry_Moment, 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  Degree_Response_Data  [0..1]  Response element for Get Degrees.   
top
 

Degree_Request_References

part of: Get_Degrees_Request, Get_Degrees_Response
Utilize the Request References element to retrieve a specific instance(s) of Degree and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Degree_Reference  DegreeObject  [1..*]  A unique identifier used to reference a Degree.   
top
 

DegreeObject

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

DegreeObjectID

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

Degree_Response_Data

part of: Get_Degrees_Response
Contains the Get Degrees Response Data
 
Parameter name Type/Value Cardinality Description Validations
Degree  Degree  [0..*]  Encapsulating element containing all Degree data.   
top
 

Degree

part of: Degree_Response_Data
Contains the Response Data from the Get Degrees operation.
 
Parameter name Type/Value Cardinality Description Validations
Degree_Reference  DegreeObject  [0..1]  Reference to an existing Degree. Only needed when updating the Reference ID for the Degree.   
Degree_Data  Degree_Data  [0..1]  Contains the detailed information about a Degree.   
top
 

Degree_Data

part of: Degree
This element contains the data elements for a Degree.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Degree ID. This is the unique identifier for a Degree. 
Validation Description
A Degree exists with the same Degree ID.   
 
Name  string  [0..1]  This is the name of the Degree with more validation for Localized Degrees. Non-blank value allowed. 
Validation Description
Name is required.   
You either have a duplicate degree for one or more countries or you are trying to restrict a degree that is available for all countries and already in use. If you have a duplicate degree, remove, merge, or inactivate the extra degrees. If you need to restrict a degree that is in use, inactivate the current degree and create a copy of it with the necessary restrictions.   
 
Rating_Value  decimal (11, 2) >0   [0..1]  This is the rating value for the Degree.   
Description  string  [0..1]  This is the description of the Degree.   
Inactive  boolean  [0..1]  Indicates if the degree is inactive. If a degree is inactive, it will no longer be allowed to be selected when a worker adds an education.   
Restricted_to_Countries_Reference  CountryObject  [0..*]  Indicates that the degree is restricted by the country / countries 
Validation Description
You are trying to restrict a degree that is available for all countries and already in use. If you need to restrict a degree that is in use, inactivate the current degree and create a copy of it with the necessary restrictions.   
You cannot remove any countries from the Restricted to Countries field for the [degree] degree because it is already in use.   
 
top
 

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [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
 

DegreeReferenceEnumeration

part of: DegreeObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top