GET survey/{surveyId}

Gets user survey questions.

Authorization

Access to this endpoint is granted if all following conditions are true:

  • Authenticated user who is either StaffMember, Student, Administrator, ProspectWithTrial, User
  • Authenticated user who is either StaffMember, Student, QA, ISUSTeacher, Administrator, ProspectWithTrial, User

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

The survey id.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

PearsonEnglish.LearningServices.Core.Models.Views.SurveyViewModel
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Title

string

None.

Sections

Collection of PearsonEnglish.LearningServices.Core.Models.Views.SurveySectionViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "f96279f4-09d8-4b74-8e58-aecfe557f09f",
  "Title": "sample string 2",
  "Sections": [
    {
      "Id": "d11efc26-5607-47ae-8d75-6649c375d1dc",
      "Title": "sample string 2",
      "Questions": [
        {
          "Id": "df31bf3d-62ed-4b7d-bcd5-fcc14c204ac0",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "Media": {
            "Type": 1,
            "URL": "sample string 2"
          },
          "AnswerRequired": true,
          "Answers": [
            {
              "Id": "fbc06fc6-d339-4762-a5ad-68c2c6606449",
              "Value": "sample string 2"
            },
            {
              "Id": "fbc06fc6-d339-4762-a5ad-68c2c6606449",
              "Value": "sample string 2"
            }
          ]
        },
        {
          "Id": "df31bf3d-62ed-4b7d-bcd5-fcc14c204ac0",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "Media": {
            "Type": 1,
            "URL": "sample string 2"
          },
          "AnswerRequired": true,
          "Answers": [
            {
              "Id": "fbc06fc6-d339-4762-a5ad-68c2c6606449",
              "Value": "sample string 2"
            },
            {
              "Id": "fbc06fc6-d339-4762-a5ad-68c2c6606449",
              "Value": "sample string 2"
            }
          ]
        }
      ]
    },
    {
      "Id": "d11efc26-5607-47ae-8d75-6649c375d1dc",
      "Title": "sample string 2",
      "Questions": [
        {
          "Id": "df31bf3d-62ed-4b7d-bcd5-fcc14c204ac0",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "Media": {
            "Type": 1,
            "URL": "sample string 2"
          },
          "AnswerRequired": true,
          "Answers": [
            {
              "Id": "fbc06fc6-d339-4762-a5ad-68c2c6606449",
              "Value": "sample string 2"
            },
            {
              "Id": "fbc06fc6-d339-4762-a5ad-68c2c6606449",
              "Value": "sample string 2"
            }
          ]
        },
        {
          "Id": "df31bf3d-62ed-4b7d-bcd5-fcc14c204ac0",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "Media": {
            "Type": 1,
            "URL": "sample string 2"
          },
          "AnswerRequired": true,
          "Answers": [
            {
              "Id": "fbc06fc6-d339-4762-a5ad-68c2c6606449",
              "Value": "sample string 2"
            },
            {
              "Id": "fbc06fc6-d339-4762-a5ad-68c2c6606449",
              "Value": "sample string 2"
            }
          ]
        }
      ]
    }
  ]
}