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

Name	Description	Type	Additional information
surveyId	The id of the survey	string	Required

Body Parameters

None.

Response Information

Resource Description

Returns the quota definition

Response Message

SurveyQuotaFrameResponseModel

Name	Description	Type	Additional 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": "85277033-04b9-467d-8835-3b97f18e5af4",
      "Name": "sample string 2",
      "OdinVariableName": "sample string 3",
      "IsSelectionOptional": true,
      "IsMulti": true,
      "Levels": [
        {
          "Id": "32dbf9d2-de27-4c1a-aafa-4b2003b0bbc1",
          "Name": "sample string 2"
        },
        {
          "Id": "32dbf9d2-de27-4c1a-aafa-4b2003b0bbc1",
          "Name": "sample string 2"
        }
      ]
    },
    {
      "Id": "85277033-04b9-467d-8835-3b97f18e5af4",
      "Name": "sample string 2",
      "OdinVariableName": "sample string 3",
      "IsSelectionOptional": true,
      "IsMulti": true,
      "Levels": [
        {
          "Id": "32dbf9d2-de27-4c1a-aafa-4b2003b0bbc1",
          "Name": "sample string 2"
        },
        {
          "Id": "32dbf9d2-de27-4c1a-aafa-4b2003b0bbc1",
          "Name": "sample string 2"
        }
      ]
    }
  ],
  "FrameVariables": [
    {
      "Id": "13b0cd5a-977c-45ff-a30d-7361c170b679",
      "DefinitionId": "e5d6721e-0872-4a01-b782-59cdf9ae0df6",
      "Levels": [
        {
          "Id": "71f43825-6123-46ed-80c5-18d92f76fd54",
          "DefinitionId": "1aa414a3-4152-4c60-8ad8-9e09a09133a8",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        },
        {
          "Id": "71f43825-6123-46ed-80c5-18d92f76fd54",
          "DefinitionId": "1aa414a3-4152-4c60-8ad8-9e09a09133a8",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        }
      ],
      "IsHidden": true
    },
    {
      "Id": "13b0cd5a-977c-45ff-a30d-7361c170b679",
      "DefinitionId": "e5d6721e-0872-4a01-b782-59cdf9ae0df6",
      "Levels": [
        {
          "Id": "71f43825-6123-46ed-80c5-18d92f76fd54",
          "DefinitionId": "1aa414a3-4152-4c60-8ad8-9e09a09133a8",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        },
        {
          "Id": "71f43825-6123-46ed-80c5-18d92f76fd54",
          "DefinitionId": "1aa414a3-4152-4c60-8ad8-9e09a09133a8",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        }
      ],
      "IsHidden": true
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.