Service Directory > v32.1 > Financial_Management > Get_Surveys
 

Operation: Get_Surveys

Used to get a Survey from the Workday system.


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

Request to get a survey.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Survey_Request_References  [0..1]  Contains the specific instance set containing the requested Survey.   
Request_Criteria [Choice]   Survey_Request_Criteria  [0..1]  Not used.   
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_Surveys_Response

Responds with the Survey(s) requested.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Survey_Request_References  [0..1]  Contains the specific instance set containing the requested Survey.   
Request_Criteria  Survey_Request_Criteria  [0..1]  Not used.   
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  Survey_Response_Data  [0..1]  Get Survey Data   
top
 

Survey_Request_References

part of: Get_Surveys_Request, Get_Surveys_Response
Contains the specific instance set containing the requested Survey.
 
Parameter name Type/Value Cardinality Description Validations
Survey_Reference  Effort_Certification_SurveyObject  [1..*]  References to a specific Survey for update only purposes.   
top
 

Effort_Certification_SurveyObject

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

Effort_Certification_SurveyObjectID

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

Survey_Request_Criteria

part of: Get_Surveys_Request, Get_Surveys_Response
Not used.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Surveys_Request, Get_Surveys_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_Surveys_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
 

Survey_Response_Data

part of: Get_Surveys_Response
Get Survey Data
 
Parameter name Type/Value Cardinality Description Validations
Survey  Survey  [0..*]  Contains Survey Data   
top
 

Survey

part of: Survey_Response_Data
Contains Survey Data
 
Parameter name Type/Value Cardinality Description Validations
Survey_Reference  Effort_Certification_SurveyObject  [0..1]  Reference to an existing Survey.   
Survey_Data_Reference  Survey_Data  [0..*]  Contains all of the data for a Survey.   
top
 

Survey_Data

part of: Survey
Contains all of the data for a Survey.
 
Parameter name Type/Value Cardinality Description Validations
Survey_Type_Reference  Effort_Certification_Survey_TypeObject  [0..1]  Type of Survey   
Survey_Name  string  [0..1]  Survey Name   
Survey_Question_Reference  Survey_Question_Data  [0..*]  Reference to all of the questions for a Survey.   
top
 

Effort_Certification_Survey_TypeObject

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

Effort_Certification_Survey_TypeObjectID

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

Survey_Question_Data

part of: Survey_Data
Contains the data for questions that are a part of a Survey.
 
Parameter name Type/Value Cardinality Description Validations
Survey_Question_Order  string  [0..1]  Order that the Questions will be displayed in (ascending).   
Survey_Question_Type_Reference  Effort_Certification_Survey_Question_TypeObject  [0..1]  Reference to the type of Question being asked.   
Survey_Question_Required  boolean  [0..1]  This specifies whether the response to this Question is required when filling out this Survey.   
Survey_Question_Text  string  [0..1]  A question to be asked as part of a Survey.   
Multiple_Choice_Question_Option_Reference  Multiple_Choice_Question_Option_Data  [0..*]  Reference to all of the possible responses to a Question of type 'Multiple Choice'.   
top
 

Effort_Certification_Survey_Question_TypeObject

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

Effort_Certification_Survey_Question_TypeObjectID

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

Multiple_Choice_Question_Option_Data

part of: Survey_Question_Data
Contains all of the response options for a question of type 'Multiple Choice'.
 
Parameter name Type/Value Cardinality Description Validations
Multiple_Choice_Question_Option_Order  string  [0..1]  Order that the response options will be displayed in (ascending).   
Multiple_Choice_Quesiton_Option_Text  string  [0..1]  Response options for a question of type 'Multiple Choice'. 
Validation Description
Survey Question Type must be 'Multiple Choice' in order to add Multiple Choice Options.   
 
top
 

Effort_Certification_SurveyReferenceEnumeration

part of: Effort_Certification_SurveyObjectID
Base Type
string
top
 

Effort_Certification_Survey_TypeReferenceEnumeration

part of: Effort_Certification_Survey_TypeObjectID
Base Type
string
top
 

Effort_Certification_Survey_Question_TypeReferenceEnumeration

part of: Effort_Certification_Survey_Question_TypeObjectID
Base Type
string
top