Service Directory > v31.2 > Financial_Management > Put_Survey
 

Operation: Put_Survey

This service operation with add or update Surveys. You may only update a Survey currently in the system if it has no Survey Responses to the questions. If you wish to update a Survey that has been responded to, please make a new Survey.


@ - 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: Put_Survey_Request

Contains all of the data for a Survey.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Survey_Reference  Effort_Certification_SurveyObject  [0..1]  Survey Reference   
Survey_Data  Survey_Data  [0..1]  Contains all of the data for a Survey.   
Validation Description
The Web Service is set to Add Only; but the Survey already exists.  Create a new Survey, or change 'Add Only' to 'false' to edit the Survey. 
The Survey you are trying to edit already has responses and is not eligible to be changed.  You may edit a Survey without any responses, or create a new Survey. 
top
 

Response Element: Put_Survey_Response

Returns Survey data in the Response to putting a Survey.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Survey_Reference  Effort_Certification_SurveyObject  [0..1]  The instance of the Survey.   
top
 

Effort_Certification_SurveyObject

part of: Put_Survey_Request, Put_Survey_Response
 
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_Data

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