PUT v1/Surveys/{surveyId}/SurveyQuotaFrame
User roles allowed to make this request:
DomainAdministrator
PowerUser
RegularUser
LimitedUser
OperationsUser
SampleManager
Permissions required to make this request:
SurveyQuotaTarget.Write
SurveyQuotaTarget.Read
SurveyQuotaFrame.Read
Survey.Read
SurveyQuotaFrame.Write
Supports blueprint surveys
This method creates or updates the survey quota frame NB: Make sure all the Id's are valid GUID's. NB: All the strings will be trimmed during the upload.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
surveyId |
id of the survey |
string |
Required |
Body Parameters
The new quota frame
SurveyQuotaFrameRequestModelName | Description | Type | Additional information |
---|---|---|---|
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. |
Request Formats
application/json, text/json
{ "Target": 1, "VariableDefinitions": [ { "Id": "c4d57f6a-1af9-4356-82d9-e63d534e4478", "Name": "sample string 2", "OdinVariableName": "sample string 3", "IsSelectionOptional": true, "IsMulti": true, "Levels": [ { "Id": "aed40ded-1b74-4d0f-8015-18760df43615", "Name": "sample string 2" }, { "Id": "aed40ded-1b74-4d0f-8015-18760df43615", "Name": "sample string 2" } ] }, { "Id": "c4d57f6a-1af9-4356-82d9-e63d534e4478", "Name": "sample string 2", "OdinVariableName": "sample string 3", "IsSelectionOptional": true, "IsMulti": true, "Levels": [ { "Id": "aed40ded-1b74-4d0f-8015-18760df43615", "Name": "sample string 2" }, { "Id": "aed40ded-1b74-4d0f-8015-18760df43615", "Name": "sample string 2" } ] } ], "FrameVariables": [ { "Id": "b577f99b-9cdf-4f6d-aff1-4bfaf98013f5", "DefinitionId": "9bd8737d-1175-4047-807a-d8c1ffbdc200", "Levels": [ { "Id": "2b4fb8a6-e8fe-488e-b017-52733be7e88d", "DefinitionId": "5fb7b367-9ab2-4835-b57e-ab81cfb54e80", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true }, { "Id": "2b4fb8a6-e8fe-488e-b017-52733be7e88d", "DefinitionId": "5fb7b367-9ab2-4835-b57e-ab81cfb54e80", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true } ], "IsHidden": true }, { "Id": "b577f99b-9cdf-4f6d-aff1-4bfaf98013f5", "DefinitionId": "9bd8737d-1175-4047-807a-d8c1ffbdc200", "Levels": [ { "Id": "2b4fb8a6-e8fe-488e-b017-52733be7e88d", "DefinitionId": "5fb7b367-9ab2-4835-b57e-ab81cfb54e80", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true }, { "Id": "2b4fb8a6-e8fe-488e-b017-52733be7e88d", "DefinitionId": "5fb7b367-9ab2-4835-b57e-ab81cfb54e80", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true } ], "IsHidden": true } ] }
application/xml
Sample not available.
text/xml
Sample not available.
application/x-www-form-urlencoded
Target=1&VariableDefinitions=IEnumerable`1&FrameVariables=IEnumerable`1
multipart/form-data
Sample not available.
Response Information
Resource Description
If successful, this method returns the newly created or updated quota frame
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": "680a00c3-ed5d-43f2-97f2-e5911707ea74", "Name": "sample string 2", "OdinVariableName": "sample string 3", "IsSelectionOptional": true, "IsMulti": true, "Levels": [ { "Id": "d0b73da5-55a8-43c0-8055-925f61eadb03", "Name": "sample string 2" }, { "Id": "d0b73da5-55a8-43c0-8055-925f61eadb03", "Name": "sample string 2" } ] }, { "Id": "680a00c3-ed5d-43f2-97f2-e5911707ea74", "Name": "sample string 2", "OdinVariableName": "sample string 3", "IsSelectionOptional": true, "IsMulti": true, "Levels": [ { "Id": "d0b73da5-55a8-43c0-8055-925f61eadb03", "Name": "sample string 2" }, { "Id": "d0b73da5-55a8-43c0-8055-925f61eadb03", "Name": "sample string 2" } ] } ], "FrameVariables": [ { "Id": "1c18e8ad-236d-4fec-8da9-55af1a36cf69", "DefinitionId": "9eab2332-1fca-4ea0-8543-b8b6e626c064", "Levels": [ { "Id": "fd83d995-9491-4d42-ad18-91bf03359968", "DefinitionId": "56fa7aff-3597-4a5b-a58e-3edd44ee7d08", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true }, { "Id": "fd83d995-9491-4d42-ad18-91bf03359968", "DefinitionId": "56fa7aff-3597-4a5b-a58e-3edd44ee7d08", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true } ], "IsHidden": true }, { "Id": "1c18e8ad-236d-4fec-8da9-55af1a36cf69", "DefinitionId": "9eab2332-1fca-4ea0-8543-b8b6e626c064", "Levels": [ { "Id": "fd83d995-9491-4d42-ad18-91bf03359968", "DefinitionId": "56fa7aff-3597-4a5b-a58e-3edd44ee7d08", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true }, { "Id": "fd83d995-9491-4d42-ad18-91bf03359968", "DefinitionId": "56fa7aff-3597-4a5b-a58e-3edd44ee7d08", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true } ], "IsHidden": true } ] }
application/xml
Sample not available.
text/xml
Sample not available.