GET v1/Surveys/{surveyId}/QuotaTargets

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

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

Supports survey simulations

This method retrieves a Full QuotaFrame structure based on survey The successful counts are not retrieved

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

The id of the survey

string

Required

Body Parameters

None.

Response Information

Resource Description

Returns a list of quota level targets. Without successful counts

Response Message

SurveysQuotaFrameResponseModel
NameDescriptionTypeAdditional information
Id

string

None.

Variables

Collection of SurveysQuotaFrameVariable

None.

Target

Target counts

integer

None.

Successful

Successful counts, only retrieved when ETag is specified

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Variables": [
    {
      "Id": "24830680-54f1-4c9f-b2fe-5f80af7ea8f7",
      "Name": "sample string 2",
      "IsMulti": true,
      "Levels": [
        {
          "Id": "bba572af-1295-4beb-81f1-9eeecb138593",
          "Name": "sample string 2",
          "Variables": [],
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Successful": 3,
          "DisplayIndex": 4
        },
        {
          "Id": "bba572af-1295-4beb-81f1-9eeecb138593",
          "Name": "sample string 2",
          "Variables": [],
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Successful": 3,
          "DisplayIndex": 4
        }
      ],
      "DisplayIndex": 4
    },
    {
      "Id": "24830680-54f1-4c9f-b2fe-5f80af7ea8f7",
      "Name": "sample string 2",
      "IsMulti": true,
      "Levels": [
        {
          "Id": "bba572af-1295-4beb-81f1-9eeecb138593",
          "Name": "sample string 2",
          "Variables": [],
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Successful": 3,
          "DisplayIndex": 4
        },
        {
          "Id": "bba572af-1295-4beb-81f1-9eeecb138593",
          "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.