Service Directory > v31.2 > Talent > Get_Certifications
 

Operation: Get_Certifications

This operation retrieves the certifications 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_Certifications_Request

Top-level element for this operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Certification_Request_References  [0..1]  Containing element for one or more Reference ID elements.   
Request_Criteria [Choice]   Certification_Request_Criteria  [0..1]  Currently not in use.   
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_Group  Certification_Response_Group  [0..1]  Containing element for items specifying response characteristics.   
top
 

Response Element: Get_Certifications_Response

The top level response element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Certification_Request_References  [0..1]  This element contains references to specific instances of Certifications.   
Request_Criteria  Certification_Request_Criteria  [0..1]  This element is not currently in use.   
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  Certification_Response_Group  [0..1]  Containing element for items that specify response characteristics.   
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  Certification_Response_Data  [0..1]  Containing element for Certification data.   
top
 

Certification_Request_References

part of: Get_Certifications_Request, Get_Certifications_Response
Encapsulating element for one or more references that refer to specific instances of Certification.
 
Parameter name Type/Value Cardinality Description Validations
Certification_Reference  CertificationObject  [0..*]  Contains the reference ID element that specifies the instance.   
top
 

CertificationObject

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

CertificationObjectID

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

Certification_Request_Criteria

part of: Get_Certifications_Request, Get_Certifications_Response
Currently not in use.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Certifications_Request, Get_Certifications_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
 

Certification_Response_Group

part of: Get_Certifications_Request, Get_Certifications_Response
Containing element for items that specify response characteristics.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Set this to 1 in order to include Reference ID's in the response.   
Include_Certification_Issuer_Reference_Only  boolean  [0..1]  Set this flag to 1 to leave the name of the certification issuer out of the response and only include the reference.   
top
 

Response_Results

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

Certification_Response_Data

part of: Get_Certifications_Response
Encapsulating element for Certification.
 
Parameter name Type/Value Cardinality Description Validations
Certification  Certification  [0..*]  Encapsulating element for Certification references and data.   
top
 

Certification

part of: Certification_Response_Data
Encapsulating element for Certification Reference and Data.
 
Parameter name Type/Value Cardinality Description Validations
Certification_Reference  CertificationObject  [0..1]  Reference ID (Certification)   
Certification_Data  Certification_Data  [0..1]  The encapsulating element for Certification data. 
Validation Description
You must first enable Specialties for Certifications using the Maintain Skills and Experience Setup task.   
[specialty] is inactive. Specify an active specialty or activate this specialty on the Edit Specialty task.   
 
top
 

Certification_Data

part of: Certification
Encapsulating element for Certification data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID (Certification ID)   
Name  string  [1..1]  The name or type of the certification.   
Issuer_Reference  Certification_IssuerObject  [1..1]  The issuer of the certification.   
Country_Reference  CountryObject  [0..1]  The country where the certification is used.   
Restrict_to_Country_Region_Reference  Country_RegionObject  [0..*]  The state or province in which the certification is issued.   
Specialty_Reference  Specialty_ParentObject  [0..*]  Any specialties which are recommended for this certification.   
Restrict_Specialty_to_Certification  boolean  [0..1]  When selected, the specialty prompt displayed to workers adding certifications to their worker profile will be restricted to the mapped specialties.   
Renewable_Required_  boolean  [0..1]  Is certification renewable?   
Renewable_In__months_  decimal (12, 0) >0   [0..1]  Renewable period for certification (in months)   
Track_Exam_Date_and_Score  boolean  [0..1]  Indicates whether or not the worker holding this certification may have the exam date and score fields enabled.   
Inactive  boolean  [0..1]  Indicates whether or not this certification is active in the system and is available for users to choose from prompts.   
Usage_Count  decimal (20, 0) >0   [0..1]  The number of records in the system that refers to this certification.   
Validation Description
You must first enable Specialties for Certifications using the Maintain Skills and Experience Setup task.   
[specialty] is inactive. Specify an active specialty or activate this specialty on the Edit Specialty task.   
top
 

Certification_IssuerObject

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

Certification_IssuerObjectID

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

CountryObject

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

Country_RegionObject

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

Country_RegionObjectID

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

Specialty_ParentObject

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

Specialty_ParentObjectID

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

CertificationReferenceEnumeration

part of: CertificationObjectID
Base Type
string
top
 

Certification_IssuerReferenceEnumeration

part of: Certification_IssuerObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

Specialty_ParentReferenceEnumeration

part of: Specialty_ParentObjectID
Base Type
string
top