GET v1/Surveys/{surveyId}/SurveyQuotaFrame

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 blueprint surveys

Supports survey simulations

Retrieve the quota definition. NB: Make sure all the Id's are valid GUID's.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

The id of the survey

string

Required

Body Parameters

None.

Response Information

Resource Description

Returns the quota definition

Response Message

SurveyQuotaFrameResponseModel
NameDescriptionTypeAdditional information
Id

Returns the unique identifier of the quota frame. Ignored on the request call

string

None.

QuotaETag

Returns the unique identifier of the quota version.

integer

None.

Target

Global target of the survey quota frame

integer

None.

VariableDefinitions

Quota Variables definitions

Collection of SurveyQuotaVariableDefinitionModel

None.

FrameVariables

Frame Variables values

Collection of SurveyQuotaFrameVariableModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "QuotaETag": 1,
  "Target": 1,
  "VariableDefinitions": [
    {
      "Id": "2595e4ab-03f1-4ce0-83ba-1dfd951507b3",
      "Name": "sample string 2",
      "OdinVariableName": "sample string 3",
      "IsSelectionOptional": true,
      "IsMulti": true,
      "Levels": [
        {
          "Id": "730369fb-8958-4932-adc5-369655d0e0d0",
          "Name": "sample string 2"
        },
        {
          "Id": "730369fb-8958-4932-adc5-369655d0e0d0",
          "Name": "sample string 2"
        }
      ]
    },
    {
      "Id": "2595e4ab-03f1-4ce0-83ba-1dfd951507b3",
      "Name": "sample string 2",
      "OdinVariableName": "sample string 3",
      "IsSelectionOptional": true,
      "IsMulti": true,
      "Levels": [
        {
          "Id": "730369fb-8958-4932-adc5-369655d0e0d0",
          "Name": "sample string 2"
        },
        {
          "Id": "730369fb-8958-4932-adc5-369655d0e0d0",
          "Name": "sample string 2"
        }
      ]
    }
  ],
  "FrameVariables": [
    {
      "Id": "6593aaf9-b5aa-467b-b2d5-daa64d69e784",
      "DefinitionId": "3dca0863-cf99-4632-908e-76fda4bc0dce",
      "Levels": [
        {
          "Id": "8d68fd79-305d-4f92-aa16-355700468a50",
          "DefinitionId": "096f559e-e2be-4628-8dda-425a27fc5e2b",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        },
        {
          "Id": "8d68fd79-305d-4f92-aa16-355700468a50",
          "DefinitionId": "096f559e-e2be-4628-8dda-425a27fc5e2b",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        }
      ],
      "IsHidden": true
    },
    {
      "Id": "6593aaf9-b5aa-467b-b2d5-daa64d69e784",
      "DefinitionId": "3dca0863-cf99-4632-908e-76fda4bc0dce",
      "Levels": [
        {
          "Id": "8d68fd79-305d-4f92-aa16-355700468a50",
          "DefinitionId": "096f559e-e2be-4628-8dda-425a27fc5e2b",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        },
        {
          "Id": "8d68fd79-305d-4f92-aa16-355700468a50",
          "DefinitionId": "096f559e-e2be-4628-8dda-425a27fc5e2b",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        }
      ],
      "IsHidden": true
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.