GetSurveyFields

This method retrieves a list of a survey's pages, with each one containing a list of the fields on that page.

SOAP action: http://apiconnector.com/v2/ApiService/GetSurveyFields

📘

Input and output parameters

The input and output parameters for this method are:

Input parameters

• Survey ID - required; integer

Output parameters

• GetSurveyFieldsResult - array of SurveyPage
  • SurveyPage
    • Id - integer
    • Name - string
    • Fields - array of SurveyField
      • SurveyField
        • Id - integer
        • Type - string
        • Text - string
        • IsRequired - boolean
        • DefaultValue - string
        • Mode - string
        • Choices - array of SurveyQuestionChoice
          • SurveyQuestionChoice
            • Id - integer
            • Text - string
      • SubFields - array of SurveyField
        • SurveyField
          • Id - integer
          • Type - string
          • Text - string
          • IsRequired - boolean
          • DefaultValue - string
          • Mode - string
          • Choices - array of SurveyQuestionChoice
            • SurveyQuestionChoice
              • Id - integer
              • Text - string
          • SubFields - array of SurveyField
            • SurveyField
              • Id - integer
              • Type - string
              • Text - string
              • IsRequired - boolean
              • DefaultValue - string
              • Mode - string
              • Choices - array of SurveyQuestionChoice
                • SurveyQuestionChoice
                  • Id - integer
                  • Text - string
              • SubFields - array of SurveyField...is recursive
              • HasOtherOption - boolean
              • OtherOptionChoiceId - integer
              • OtherOptionSubFieldId - integer
              • OtherOptionTextFieldId - integer
              • IsAssignedToContactDataField - boolean
              • AssignedContactDataFieldName - string
              • AssignedContactDataExistsAction - string ('OverwriteData', 'HideField')
          • HasOtherOption - boolean
          • OtherOptionChoiceId - integer
          • OtherOptionSubFieldId - integer
          • OtherOptionTextFieldId - integer
          • IsAssignedToContactDataField - boolean
          • AssignedContactDataFieldName - string
          • AssignedContactDataExistsAction - string ('OverwriteData', 'HideField')

Example

using (var client = new ApiServiceClient())
{
	client.ClientCredentials.UserName.UserName = "username";
	client.ClientCredentials.UserName.Password = "password";

	var surveyId = 1;
	var surveyFields = client.GetSurveyFields(surveyId);
}