POST api/Survey/GetSurvey

取得問卷

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
survey_code	string	None.
encrypted_key	string	None.
data_string	string	None.

Request Formats

application/json, text/json

Sample:

{
  "survey_code": "sample string 1",
  "encrypted_key": "sample string 2",
  "data_string": "sample string 3"
}

application/xml, text/xml

Sample:

<GetSurveyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FoodApi.API_DataTransferObject">
  <data_string>sample string 3</data_string>
  <encrypted_key>sample string 2</encrypted_key>
  <survey_code>sample string 1</survey_code>
</GetSurveyRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetSurveyResponse

Name	Type	Additional information
survey_status	string	None.
survey_code	string	None.
survey	SurveyAPIDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "survey_status": "sample string 1",
  "survey_code": "sample string 2",
  "survey": {
    "name": "sample string 1",
    "welcome_text": "sample string 2",
    "thank_you_text": "sample string 3",
    "legal_text": "sample string 4",
    "completed_text": "sample string 5",
    "expired_text": "sample string 6",
    "questions": [
      {
        "type": "sample string 1",
        "name": "sample string 2",
        "remark": "sample string 3",
        "is_required": true,
        "order": 5,
        "options": [
          {
            "item_number": "sample string 1",
            "item_number2": "sample string 2",
            "item_number3": "sample string 3",
            "value": "sample string 4",
            "text_limit": 5,
            "text_validation_type": "sample string 6",
            "option_name": "sample string 7",
            "option_x_axis_name": "sample string 8",
            "option_y_axis_name": "sample string 9",
            "number_min": 10,
            "number_max": 11,
            "number_step": 12,
            "number_unit": "sample string 13",
            "date_range_from": "2026-07-16T17:33:52.1828121+08:00",
            "date_range_end": "2026-07-16T17:33:52.1828121+08:00"
          },
          {
            "item_number": "sample string 1",
            "item_number2": "sample string 2",
            "item_number3": "sample string 3",
            "value": "sample string 4",
            "text_limit": 5,
            "text_validation_type": "sample string 6",
            "option_name": "sample string 7",
            "option_x_axis_name": "sample string 8",
            "option_y_axis_name": "sample string 9",
            "number_min": 10,
            "number_max": 11,
            "number_step": 12,
            "number_unit": "sample string 13",
            "date_range_from": "2026-07-16T17:33:52.1828121+08:00",
            "date_range_end": "2026-07-16T17:33:52.1828121+08:00"
          }
        ]
      },
      {
        "type": "sample string 1",
        "name": "sample string 2",
        "remark": "sample string 3",
        "is_required": true,
        "order": 5,
        "options": [
          {
            "item_number": "sample string 1",
            "item_number2": "sample string 2",
            "item_number3": "sample string 3",
            "value": "sample string 4",
            "text_limit": 5,
            "text_validation_type": "sample string 6",
            "option_name": "sample string 7",
            "option_x_axis_name": "sample string 8",
            "option_y_axis_name": "sample string 9",
            "number_min": 10,
            "number_max": 11,
            "number_step": 12,
            "number_unit": "sample string 13",
            "date_range_from": "2026-07-16T17:33:52.1828121+08:00",
            "date_range_end": "2026-07-16T17:33:52.1828121+08:00"
          },
          {
            "item_number": "sample string 1",
            "item_number2": "sample string 2",
            "item_number3": "sample string 3",
            "value": "sample string 4",
            "text_limit": 5,
            "text_validation_type": "sample string 6",
            "option_name": "sample string 7",
            "option_x_axis_name": "sample string 8",
            "option_y_axis_name": "sample string 9",
            "number_min": 10,
            "number_max": 11,
            "number_step": 12,
            "number_unit": "sample string 13",
            "date_range_from": "2026-07-16T17:33:52.1828121+08:00",
            "date_range_end": "2026-07-16T17:33:52.1828121+08:00"
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<GetSurveyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FoodApi.API_DataTransferObject">
  <survey>
    <completed_text>sample string 5</completed_text>
    <expired_text>sample string 6</expired_text>
    <legal_text>sample string 4</legal_text>
    <name>sample string 1</name>
    <questions>
      <SurveyQuestionAPIDTO>
        <is_required>true</is_required>
        <name>sample string 2</name>
        <options>
          <SurveyOptionAPIDTO>
            <date_range_end>2026-07-16T17:33:52.1828121+08:00</date_range_end>
            <date_range_from>2026-07-16T17:33:52.1828121+08:00</date_range_from>
            <item_number>sample string 1</item_number>
            <item_number2>sample string 2</item_number2>
            <item_number3>sample string 3</item_number3>
            <number_max>11</number_max>
            <number_min>10</number_min>
            <number_step>12</number_step>
            <number_unit>sample string 13</number_unit>
            <option_name>sample string 7</option_name>
            <option_x_axis_name>sample string 8</option_x_axis_name>
            <option_y_axis_name>sample string 9</option_y_axis_name>
            <text_limit>5</text_limit>
            <text_validation_type>sample string 6</text_validation_type>
            <value>sample string 4</value>
          </SurveyOptionAPIDTO>
          <SurveyOptionAPIDTO>
            <date_range_end>2026-07-16T17:33:52.1828121+08:00</date_range_end>
            <date_range_from>2026-07-16T17:33:52.1828121+08:00</date_range_from>
            <item_number>sample string 1</item_number>
            <item_number2>sample string 2</item_number2>
            <item_number3>sample string 3</item_number3>
            <number_max>11</number_max>
            <number_min>10</number_min>
            <number_step>12</number_step>
            <number_unit>sample string 13</number_unit>
            <option_name>sample string 7</option_name>
            <option_x_axis_name>sample string 8</option_x_axis_name>
            <option_y_axis_name>sample string 9</option_y_axis_name>
            <text_limit>5</text_limit>
            <text_validation_type>sample string 6</text_validation_type>
            <value>sample string 4</value>
          </SurveyOptionAPIDTO>
        </options>
        <order>5</order>
        <remark>sample string 3</remark>
        <type>sample string 1</type>
      </SurveyQuestionAPIDTO>
      <SurveyQuestionAPIDTO>
        <is_required>true</is_required>
        <name>sample string 2</name>
        <options>
          <SurveyOptionAPIDTO>
            <date_range_end>2026-07-16T17:33:52.1828121+08:00</date_range_end>
            <date_range_from>2026-07-16T17:33:52.1828121+08:00</date_range_from>
            <item_number>sample string 1</item_number>
            <item_number2>sample string 2</item_number2>
            <item_number3>sample string 3</item_number3>
            <number_max>11</number_max>
            <number_min>10</number_min>
            <number_step>12</number_step>
            <number_unit>sample string 13</number_unit>
            <option_name>sample string 7</option_name>
            <option_x_axis_name>sample string 8</option_x_axis_name>
            <option_y_axis_name>sample string 9</option_y_axis_name>
            <text_limit>5</text_limit>
            <text_validation_type>sample string 6</text_validation_type>
            <value>sample string 4</value>
          </SurveyOptionAPIDTO>
          <SurveyOptionAPIDTO>
            <date_range_end>2026-07-16T17:33:52.1828121+08:00</date_range_end>
            <date_range_from>2026-07-16T17:33:52.1828121+08:00</date_range_from>
            <item_number>sample string 1</item_number>
            <item_number2>sample string 2</item_number2>
            <item_number3>sample string 3</item_number3>
            <number_max>11</number_max>
            <number_min>10</number_min>
            <number_step>12</number_step>
            <number_unit>sample string 13</number_unit>
            <option_name>sample string 7</option_name>
            <option_x_axis_name>sample string 8</option_x_axis_name>
            <option_y_axis_name>sample string 9</option_y_axis_name>
            <text_limit>5</text_limit>
            <text_validation_type>sample string 6</text_validation_type>
            <value>sample string 4</value>
          </SurveyOptionAPIDTO>
        </options>
        <order>5</order>
        <remark>sample string 3</remark>
        <type>sample string 1</type>
      </SurveyQuestionAPIDTO>
    </questions>
    <thank_you_text>sample string 3</thank_you_text>
    <welcome_text>sample string 2</welcome_text>
  </survey>
  <survey_code>sample string 2</survey_code>
  <survey_status>sample string 1</survey_status>
</GetSurveyResponse>