Gets a list of Questions for many Scopes

Updated
  • 3 minute(s) read
Prev Next
Get
/api/Lead/Questions
Security
HTTP
Type bearer

Enter the token obtained from the /token endpoint. Use the format: Bearer

Query parameters
scopeIds
array of integerRequired
Responses
200

Successful Response

Expand All
object
IsSuccess
boolean
Message
string
Result
Array of object (QuestionLeadOutputDto)
object
ScopeId
integer (int32)

The Scope this question is associated with

QuestionId
integer (int32)

The ID of the question

IsRequired
boolean

If true, the question must be posted and an answer supplied

QuestionText
string

The question text to be displayed

Answers
Array of object (AnswerLeadOutputDto)

List of answers to the question

object

Represents an answer options to the question

AnswerId
integer (int32)
AnswerText
string

The answer text to be displayed

Icon
string

For custom display properties

Color
string

For custom display properties

HelpText
string

Helper text to be displayed

SortOrder
integer (int32)
HelpText
string

Helper text to be displayed

Icon
string

For custom display properties

Color
string

For custom display properties

QuestionStepType
string

When the question is asked

QuestionType
string

The type of question (select list, multiple select list, text, number, etc.)

TextValue
string

The answer default value, if not supplied

PricingAdjustmentDescription
string

If the question changes affects the price

SortOrder
integer (int32)
InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
Array of object (QuestionLeadOutputDto)
object
ScopeId
integer (int32)

The Scope this question is associated with

QuestionId
integer (int32)

The ID of the question

IsRequired
boolean

If true, the question must be posted and an answer supplied

QuestionText
string

The question text to be displayed

Answers
Array of object (AnswerLeadOutputDto)

List of answers to the question

object

Represents an answer options to the question

AnswerId
integer (int32)
AnswerText
string

The answer text to be displayed

Icon
string

For custom display properties

Color
string

For custom display properties

HelpText
string

Helper text to be displayed

SortOrder
integer (int32)
HelpText
string

Helper text to be displayed

Icon
string

For custom display properties

Color
string

For custom display properties

QuestionStepType
string

When the question is asked

QuestionType
string

The type of question (select list, multiple select list, text, number, etc.)

TextValue
string

The answer default value, if not supplied

PricingAdjustmentDescription
string

If the question changes affects the price

SortOrder
integer (int32)
InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
Array of object (QuestionLeadOutputDto)
object
ScopeId
integer (int32)

The Scope this question is associated with

QuestionId
integer (int32)

The ID of the question

IsRequired
boolean

If true, the question must be posted and an answer supplied

QuestionText
string

The question text to be displayed

Answers
Array of object (AnswerLeadOutputDto)

List of answers to the question

object

Represents an answer options to the question

AnswerId
integer (int32)
AnswerText
string

The answer text to be displayed

Icon
string

For custom display properties

Color
string

For custom display properties

HelpText
string

Helper text to be displayed

SortOrder
integer (int32)
HelpText
string

Helper text to be displayed

Icon
string

For custom display properties

Color
string

For custom display properties

QuestionStepType
string

When the question is asked

QuestionType
string

The type of question (select list, multiple select list, text, number, etc.)

TextValue
string

The answer default value, if not supplied

PricingAdjustmentDescription
string

If the question changes affects the price

SortOrder
integer (int32)
InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
Array of object (QuestionLeadOutputDto)
object
ScopeId
integer (int32)

The Scope this question is associated with

QuestionId
integer (int32)

The ID of the question

IsRequired
boolean

If true, the question must be posted and an answer supplied

QuestionText
string

The question text to be displayed

Answers
Array of object (AnswerLeadOutputDto)

List of answers to the question

object

Represents an answer options to the question

AnswerId
integer (int32)
AnswerText
string

The answer text to be displayed

Icon
string

For custom display properties

Color
string

For custom display properties

HelpText
string

Helper text to be displayed

SortOrder
integer (int32)
HelpText
string

Helper text to be displayed

Icon
string

For custom display properties

Color
string

For custom display properties

QuestionStepType
string

When the question is asked

QuestionType
string

The type of question (select list, multiple select list, text, number, etc.)

TextValue
string

The answer default value, if not supplied

PricingAdjustmentDescription
string

If the question changes affects the price

SortOrder
integer (int32)
InnerException
string
StatusCode
integer (int32)
Expand All
object
IsSuccess
boolean
Message
string
Result
Array of object (QuestionLeadOutputDto)
object
ScopeId
integer (int32)

The Scope this question is associated with

QuestionId
integer (int32)

The ID of the question

IsRequired
boolean

If true, the question must be posted and an answer supplied

QuestionText
string

The question text to be displayed

Answers
Array of object (AnswerLeadOutputDto)

List of answers to the question

object

Represents an answer options to the question

AnswerId
integer (int32)
AnswerText
string

The answer text to be displayed

Icon
string

For custom display properties

Color
string

For custom display properties

HelpText
string

Helper text to be displayed

SortOrder
integer (int32)
HelpText
string

Helper text to be displayed

Icon
string

For custom display properties

Color
string

For custom display properties

QuestionStepType
string

When the question is asked

QuestionType
string

The type of question (select list, multiple select list, text, number, etc.)

TextValue
string

The answer default value, if not supplied

PricingAdjustmentDescription
string

If the question changes affects the price

SortOrder
integer (int32)
InnerException
string
StatusCode
integer (int32)