GET api/surveys/{survey}/contactform

Gives you the contact form settings of a given survey

Request Information

URI Parameters

Name	Description	Type	Additional information
survey	Survey ID	integer	Required

Body Parameters

None.

Response Information

Resource Description

Contact form settings

SurveyContactFormDTO

Name	Description	Type	Additional information
Survey	ID of parent Survey	integer	Required
Include	Whether to include a contact form in the Survey	boolean	Required
FirstName	Contact form field for user first name	SurveyContactFormFieldDTO	Required
LastName	Contact form field for user last name	SurveyContactFormFieldDTO	Required
Title	Contact form field for user title	SurveyContactFormFieldDTO	Required
Organization	Contact form field for user organization	SurveyContactFormFieldDTO	Required
Address	Contact form field for user address	SurveyContactFormFieldDTO	Required
ZIP	Contact form field for user zip code	SurveyContactFormFieldDTO	Required
City	Contact form field for user city	SurveyContactFormFieldDTO	Required
Email	Contact form field for user email address	SurveyContactFormFieldDTO	Required
Phone	Contact form field for user phone number	SurveyContactFormFieldDTO	Required
Custom1	First custom contact form field	SurveyContactFormCustomFieldDTO	Required
Custom2	Second custom contact form field	SurveyContactFormCustomFieldDTO	Required
Custom3	Third custom contact form field	SurveyContactFormCustomFieldDTO	Required
Custom4	Forth custom contact form field	SurveyContactFormCustomFieldDTO	Required
Custom5	Fifth custom contact form field	SurveyContactFormCustomFieldDTO	Required

Response Formats

application/json, text/json

Sample:

{
  "Survey": 1,
  "Include": true,
  "FirstName": {
    "Include": true,
    "Comment": "sample string 2"
  },
  "LastName": {
    "Include": true,
    "Comment": "sample string 2"
  },
  "Title": {
    "Include": true,
    "Comment": "sample string 2"
  },
  "Organization": {
    "Include": true,
    "Comment": "sample string 2"
  },
  "Address": {
    "Include": true,
    "Comment": "sample string 2"
  },
  "ZIP": {
    "Include": true,
    "Comment": "sample string 2"
  },
  "City": {
    "Include": true,
    "Comment": "sample string 2"
  },
  "Email": {
    "Include": true,
    "Comment": "sample string 2"
  },
  "Phone": {
    "Include": true,
    "Comment": "sample string 2"
  },
  "Custom1": {
    "Name": "sample string 1",
    "Include": true,
    "Comment": "sample string 3"
  },
  "Custom2": {
    "Name": "sample string 1",
    "Include": true,
    "Comment": "sample string 3"
  },
  "Custom3": {
    "Name": "sample string 1",
    "Include": true,
    "Comment": "sample string 3"
  },
  "Custom4": {
    "Name": "sample string 1",
    "Include": true,
    "Comment": "sample string 3"
  },
  "Custom5": {
    "Name": "sample string 1",
    "Include": true,
    "Comment": "sample string 3"
  }
}