GET Api/TouchPoint/GetNextQuestion?schedule_id={schedule_id}

The api/TouchPoint/GetNextQuestion method will lookup the TouchPoint instance by the schedule_id and return the next question that has not yet been answered.

Request Information

URI Parameters

Name	Description	Type	Additional information
schedule_id		integer	Required

Body Parameters

None.

Response Information

Resource Description

Question.

Question

Name	Type	Additional information
schedule_id	integer	None.
all_questions_answered	boolean	None.
question_id	integer	None.
question	string	None.
question_html	string	None.
question_type	string	None.
resp_type	string	None.
resp_type_id	integer	None.
result	TPCResponse	None.
multiple_choice_options	Collection of multiple_choice_option	None.

Response Formats

application/json, text/json

Sample:

{
  "schedule_id": 1,
  "all_questions_answered": true,
  "question_id": 3,
  "question": "sample string 4",
  "question_html": "sample string 5",
  "question_type": "sample string 6",
  "resp_type": "sample string 7",
  "resp_type_id": 8,
  "result": {
    "result": "sample string 1",
    "error_code": 1,
    "message": "sample string 2"
  },
  "multiple_choice_options": [
    {
      "id": 1,
      "text": "sample string 2"
    },
    {
      "id": 1,
      "text": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<Question xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.API.Models">
  <all_questions_answered>true</all_questions_answered>
  <multiple_choice_options>
    <multiple_choice_option>
      <id>1</id>
      <text>sample string 2</text>
    </multiple_choice_option>
    <multiple_choice_option>
      <id>1</id>
      <text>sample string 2</text>
    </multiple_choice_option>
  </multiple_choice_options>
  <question>sample string 4</question>
  <question_html>sample string 5</question_html>
  <question_id>3</question_id>
  <question_type>sample string 6</question_type>
  <resp_type>sample string 7</resp_type>
  <resp_type_id>8</resp_type_id>
  <result>
    <error_code>1</error_code>
    <message>sample string 2</message>
    <result>sample string 1</result>
  </result>
  <schedule_id>1</schedule_id>
</Question>