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

Name	Description	Type	Additional 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

Name	Description	Type	Additional 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": "48cc6807-4eff-4718-8d63-5012fb7cb6a1",
      "Name": "sample string 2",
      "IsMulti": true,
      "Levels": [
        {
          "Id": "5f16e41c-82b6-4b7c-9d25-ce91af344422",
          "Name": "sample string 2",
          "Variables": [],
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Successful": 3,
          "DisplayIndex": 4
        },
        {
          "Id": "5f16e41c-82b6-4b7c-9d25-ce91af344422",
          "Name": "sample string 2",
          "Variables": [],
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Successful": 3,
          "DisplayIndex": 4
        }
      ],
      "DisplayIndex": 4
    },
    {
      "Id": "48cc6807-4eff-4718-8d63-5012fb7cb6a1",
      "Name": "sample string 2",
      "IsMulti": true,
      "Levels": [
        {
          "Id": "5f16e41c-82b6-4b7c-9d25-ce91af344422",
          "Name": "sample string 2",
          "Variables": [],
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Successful": 3,
          "DisplayIndex": 4
        },
        {
          "Id": "5f16e41c-82b6-4b7c-9d25-ce91af344422",
          "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.