GET v1/Surveys/{surveyId}/QuotaVersions/{eTag}

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser Supervisor LimitedUser QuotaManager OperationsUser SampleManager DemoUser

Permissions required to make this request: SurveyQuotaFrameCount.Read SurveyQuotaFrame.Read Survey.Read

Supports survey simulations

This method retrieves quota frame for the specified version.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

The id of the survey to get the quota frame

string

Required

eTag

The version of the quota frame to retrieve

string

Required

Body Parameters

None.

Response Information

Resource Description

The quota frame

Response Message

QuotaFrameModel
NameDescriptionTypeAdditional information
Id

The unique identifier for a quota frame version

string

None.

Variables

Collection of quota frame variables

Collection of QuotaFrameVariable

None.

Target

Quota target

integer

None.

Successful

Successful count

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Variables": [
    {
      "Id": "8356ea1b-389e-4732-8765-ed5f00721b53",
      "Name": "sample string 2",
      "IsMulti": true,
      "Levels": [
        {
          "Id": "f6505edd-590e-48ad-80a4-37d3c685a763",
          "Name": "sample string 2",
          "Variables": [],
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Successful": 3,
          "DisplayIndex": 4
        },
        {
          "Id": "f6505edd-590e-48ad-80a4-37d3c685a763",
          "Name": "sample string 2",
          "Variables": [],
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Successful": 3,
          "DisplayIndex": 4
        }
      ],
      "DisplayIndex": 4
    },
    {
      "Id": "8356ea1b-389e-4732-8765-ed5f00721b53",
      "Name": "sample string 2",
      "IsMulti": true,
      "Levels": [
        {
          "Id": "f6505edd-590e-48ad-80a4-37d3c685a763",
          "Name": "sample string 2",
          "Variables": [],
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Successful": 3,
          "DisplayIndex": 4
        },
        {
          "Id": "f6505edd-590e-48ad-80a4-37d3c685a763",
          "Name": "sample string 2",
          "Variables": [],
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Successful": 3,
          "DisplayIndex": 4
        }
      ],
      "DisplayIndex": 4
    }
  ],
  "Target": 1,
  "Successful": 2
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.