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
SurveyQuotaFrameResponseModelName | 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
{ "Id": "sample string 1", "QuotaETag": 1, "Target": 1, "VariableDefinitions": [ { "Id": "9c1b36d5-cec2-45f9-926d-ae6087fee303", "Name": "sample string 2", "OdinVariableName": "sample string 3", "IsSelectionOptional": true, "IsMulti": true, "Levels": [ { "Id": "e7f526ac-e94d-42c5-a299-6a45fc7d2065", "Name": "sample string 2" }, { "Id": "e7f526ac-e94d-42c5-a299-6a45fc7d2065", "Name": "sample string 2" } ] }, { "Id": "9c1b36d5-cec2-45f9-926d-ae6087fee303", "Name": "sample string 2", "OdinVariableName": "sample string 3", "IsSelectionOptional": true, "IsMulti": true, "Levels": [ { "Id": "e7f526ac-e94d-42c5-a299-6a45fc7d2065", "Name": "sample string 2" }, { "Id": "e7f526ac-e94d-42c5-a299-6a45fc7d2065", "Name": "sample string 2" } ] } ], "FrameVariables": [ { "Id": "7e876bf8-4bc7-44dc-a270-898ad9c1e217", "DefinitionId": "d73e7354-7e3c-4ed1-b5aa-de2dcd59493b", "Levels": [ { "Id": "4ee38847-be4c-48cc-b80d-effa101b8ebb", "DefinitionId": "c0ababa3-5426-44cf-9783-22c422d116b4", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true }, { "Id": "4ee38847-be4c-48cc-b80d-effa101b8ebb", "DefinitionId": "c0ababa3-5426-44cf-9783-22c422d116b4", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true } ], "IsHidden": true }, { "Id": "7e876bf8-4bc7-44dc-a270-898ad9c1e217", "DefinitionId": "d73e7354-7e3c-4ed1-b5aa-de2dcd59493b", "Levels": [ { "Id": "4ee38847-be4c-48cc-b80d-effa101b8ebb", "DefinitionId": "c0ababa3-5426-44cf-9783-22c422d116b4", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true }, { "Id": "4ee38847-be4c-48cc-b80d-effa101b8ebb", "DefinitionId": "c0ababa3-5426-44cf-9783-22c422d116b4", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true } ], "IsHidden": true } ] }
application/xml
Sample not available.
text/xml
Sample not available.