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": "018fdaae-ed3a-4988-b707-14ce25680372", "Name": "sample string 2", "OdinVariableName": "sample string 3", "IsSelectionOptional": true, "IsMulti": true, "Levels": [ { "Id": "ca4651bd-3627-431d-9008-87c5d95047e8", "Name": "sample string 2" }, { "Id": "ca4651bd-3627-431d-9008-87c5d95047e8", "Name": "sample string 2" } ] }, { "Id": "018fdaae-ed3a-4988-b707-14ce25680372", "Name": "sample string 2", "OdinVariableName": "sample string 3", "IsSelectionOptional": true, "IsMulti": true, "Levels": [ { "Id": "ca4651bd-3627-431d-9008-87c5d95047e8", "Name": "sample string 2" }, { "Id": "ca4651bd-3627-431d-9008-87c5d95047e8", "Name": "sample string 2" } ] } ], "FrameVariables": [ { "Id": "8c7a9c65-3748-42d9-90de-b3b1f8520dcf", "DefinitionId": "53aca0f5-f40d-4013-84de-baeeab14d5e4", "Levels": [ { "Id": "087e6d8a-b83f-4f5a-ab8f-f16cb6345146", "DefinitionId": "94f06014-00ed-4ec3-83f1-9422434cf51d", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true }, { "Id": "087e6d8a-b83f-4f5a-ab8f-f16cb6345146", "DefinitionId": "94f06014-00ed-4ec3-83f1-9422434cf51d", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true } ], "IsHidden": true }, { "Id": "8c7a9c65-3748-42d9-90de-b3b1f8520dcf", "DefinitionId": "53aca0f5-f40d-4013-84de-baeeab14d5e4", "Levels": [ { "Id": "087e6d8a-b83f-4f5a-ab8f-f16cb6345146", "DefinitionId": "94f06014-00ed-4ec3-83f1-9422434cf51d", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true }, { "Id": "087e6d8a-b83f-4f5a-ab8f-f16cb6345146", "DefinitionId": "94f06014-00ed-4ec3-83f1-9422434cf51d", "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": "4f9deeea-24fa-4bcb-acbd-18c11183c4e7", "Name": "sample string 2", "OdinVariableName": "sample string 3", "IsSelectionOptional": true, "IsMulti": true, "Levels": [ { "Id": "901327d2-c99d-433e-b545-e0cf38e4b20d", "Name": "sample string 2" }, { "Id": "901327d2-c99d-433e-b545-e0cf38e4b20d", "Name": "sample string 2" } ] }, { "Id": "4f9deeea-24fa-4bcb-acbd-18c11183c4e7", "Name": "sample string 2", "OdinVariableName": "sample string 3", "IsSelectionOptional": true, "IsMulti": true, "Levels": [ { "Id": "901327d2-c99d-433e-b545-e0cf38e4b20d", "Name": "sample string 2" }, { "Id": "901327d2-c99d-433e-b545-e0cf38e4b20d", "Name": "sample string 2" } ] } ], "FrameVariables": [ { "Id": "05743d1b-f47d-4807-b037-11b42158d810", "DefinitionId": "6fdc5526-4e83-4f35-ab43-fe7598c7aeca", "Levels": [ { "Id": "902aa7e5-2f10-4bea-9324-3fc649d76402", "DefinitionId": "3b76a5e5-2a04-4ff2-abf4-9bc972701c10", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true }, { "Id": "902aa7e5-2f10-4bea-9324-3fc649d76402", "DefinitionId": "3b76a5e5-2a04-4ff2-abf4-9bc972701c10", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true } ], "IsHidden": true }, { "Id": "05743d1b-f47d-4807-b037-11b42158d810", "DefinitionId": "6fdc5526-4e83-4f35-ab43-fe7598c7aeca", "Levels": [ { "Id": "902aa7e5-2f10-4bea-9324-3fc649d76402", "DefinitionId": "3b76a5e5-2a04-4ff2-abf4-9bc972701c10", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true }, { "Id": "902aa7e5-2f10-4bea-9324-3fc649d76402", "DefinitionId": "3b76a5e5-2a04-4ff2-abf4-9bc972701c10", "Target": 1, "MaxTarget": 1, "MaxOvershoot": 1, "Variables": [], "IsHidden": true } ], "IsHidden": true } ] }
application/xml
Sample not available.
text/xml
Sample not available.