Print this Page

SURVEY Functions

Below is a listing of all the functions.

 

SurveyAddAnswer

SurveyAddAnswer

This method adds a survey answer to a survey question.

 

Return Type: n/a

 

Name

Type

Description

Answer

String

The text for the answer.

QuestionID

Integer

The ID of the survey question to add the survey answers to.

 

SurveyAddQuestion

SurveyAddQuestion

This method adds a question to the forums survey question list.

 

Return Type: n/a

 

Name

Type

Description

Question

String

The text for the survey question.

QuestionType

String

The type of field the survey question is. DD for a drop down, FT for a free text field.

Required

Integer

Determines of the question is required or not (0 = not required, 1 = required)

ForumID

Integer

The ID for the forum to add the survey question to.

CategoryID

Integer

The Category ID of the survey. Use 0 if the survey is a profile survey use 0.

 

SurveyDeleteAnswer

SurveyDeleteAnswer

This method deletes a survey answer.

 

Return Type: n/a

 

Name

Type

Description

AnswerID

Integer

The survey answer ID to delete.

 

SurveyDeleteQuestion

SurveyDeleteQuestion

This method deletes a survey question from the forum.

 

Return Type: n/a

 

Name

Type

Description

QuestionID

Integer

The ID of the survey question to delete.

CategoryID

Integer

The Category ID of the survey. Use 0 if the survey is a profile survey use 0.

 

SurveyDeleteResponseForUser

SurveyDeleteResponseForUser

This method deletes all the survey responses of a user to a specified category.

 

Return Type: n/a

 

Name

Type

Description

UserID

Integer

The user ID for the user to delete the responses.

CategoryID

Integer

The ID of the category.

 

SurveyGetAnswerByID

SurveyGetAnswerByID

This method gets a survey answer by answer ID.

 

Return Type:  SurveyAnswer

 

Name

Type

Description

AnswerID

Integer

The survey answer ID to retrieve.

 

Related Items

SurveyGetAnswers

 

SurveyGetAnswers

SurveyGetAnswers

This method gets the survey answers for a survey question.

 

Return Type:  SurveyAnswer()

 

Name

Type

Description

QuestionID

Integer

The ID of the survey question to get answers for.

 

Related Items

SurveyGetAnswerByID

 

SurveyGetQuestionByID

SurveyGetQuestionByID

This method gets survey question information for a specified question.

 

Return Type:  SurveyQuestion

 

Name

Type

Description

QuestionID

Integer

The ID of the survey question to retrieve.

 

Related Items

SurveyGetQuestions

 

SurveyGetQuestions

SurveyGetQuestions

This method gets the survey questions for a forum.

 

Return Type:  SurveyQuestion()

 

Name

Type

Description

ForumID

Integer

The ID of the forum to get survey questions for.

CategoryID

Integer

The ID of the category the survey belongs to. If the survey is a profile survey this parameter should be 0.

 

Related Items

SurveyGetQuestionByID

 

SurveyGetResponses

SurveyGetResponses

This method gets the users responses for a survey question.

 

Return Type:  SurveyResponse

 

Name

Type

Description

UserID

Integer

The user ID for the user to retrieve responses for.

QuestionID

Integer

The survey question ID.

 

SurveyUpdateAnswer

SurveyUpdateAnswer

This method gets a survey answer by answer ID.

 

Return Type: n/a

 

Name

Type

Description

Answer

String

The text for the survey answer.

AnswerID

Integer

The survey answer ID to update.

 

SurveyUpdateQuestion

SurveyUpdateQuestion

This method updates a survey question.

 

Return Type: n/a

 

Name

Type

Description

Question

String

The text for the survey question.

QuestionType

String

The type of field the survey question is. DD for a drop down, FT for a free text field.

Required

Integer

Determines of the question is required or not (0 = not required, 1 = required)

QuestionID

Integer

The ID of the survey question to update.