Service Directory > v31.2 > Financial_Management > Get_Effort_Certifying_Texts
 

Operation: Get_Effort_Certifying_Texts

This service operation will retrieve a specified Effort Certifying Text (if specified) or will return all Effort Certifying Texts.


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

Contains Effort Certifying Text Request Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Effort_Certifying_Text_Request_References  [0..1]  Reference to existing Effort Certifying Text.   
Request_Criteria [Choice]   Effort_Certifying_Text_Request_Criteria  [0..1]  Get Effort Certifying Text 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_Effort_Certifying_Texts_Response

Element containing Effort Certifying Text response elements including received criteria, references, data based on criteria, results filter and result summary.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Effort_Certifying_Text_Request_References  [0..1]  Request References   
Request_Criteria  Effort_Certifying_Text_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. 
 
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  Effort_Certifying_Text_Response_Data  [0..1]  Response Data   
top
 

Effort_Certifying_Text_Request_References

part of: Get_Effort_Certifying_Texts_Request, Get_Effort_Certifying_Texts_Response
Reference to existing Effort Certifying Text.
 
Parameter name Type/Value Cardinality Description Validations
Effort_Certifying_Text_Reference  Effort_Certifying_TextObject  [1..*]  Reference to existing Effort Certifying Text.   
top
 

Effort_Certifying_TextObject

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

Effort_Certifying_TextObjectID

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

Effort_Certifying_Text_Request_Criteria

part of: Get_Effort_Certifying_Texts_Request, Get_Effort_Certifying_Texts_Response
Get Effort Certifying Text Request Criteria.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Effort_Certifying_Texts_Request, Get_Effort_Certifying_Texts_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_Effort_Certifying_Texts_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
 

Effort_Certifying_Text_Response_Data

part of: Get_Effort_Certifying_Texts_Response
Wrapper Element that includes Effort Certifying Text Details.
 
Parameter name Type/Value Cardinality Description Validations
Effort_Certifying_Text  Effort_Certifying_Text  [0..*]  Effort Certifying Text   
top
 

Effort_Certifying_Text

part of: Effort_Certifying_Text_Response_Data
Wrapper Element that includes Effort Certifying Text Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Effort_Certifying_Text_Reference  Effort_Certifying_TextObject  [0..1]  Reference to existing Effort Certifying Text.   
Effort_Certifying_Text_Data  Effort_Certifying_Text_Data  [0..*]  Effort Certifying Text Data   
top
 

Effort_Certifying_Text_Data

part of: Effort_Certifying_Text
Effort Certifying Text Data
 
Parameter name Type/Value Cardinality Description Validations
Effort_Certifying_Text_ID  string  [0..1]  Effort Certifying Text Reference ID   
Effort_Certifying_Text_Name  string  [1..1]  Effort Certifying Text Name   
Effort_Certifying_Text  RichText  [1..1]  Effort Certifying Text   
top
 

Effort_Certifying_TextReferenceEnumeration

part of: Effort_Certifying_TextObjectID
Base Type
string
top
 

RichText

part of: Effort_Certifying_Text_Data
Base Type
string
top