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

NameDescriptionTypeAdditional information
surveyId

id of the survey

string

Required

Body Parameters

The new quota frame

SurveyQuotaFrameRequestModel
NameDescriptionTypeAdditional 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

Sample:
{
  "Target": 1,
  "VariableDefinitions": [
    {
      "Id": "31880e59-4b6d-4da3-afa4-86dd1f5b880d",
      "Name": "sample string 2",
      "OdinVariableName": "sample string 3",
      "IsSelectionOptional": true,
      "IsMulti": true,
      "Levels": [
        {
          "Id": "5320eb1c-7918-4342-ac17-3f41613fb5d9",
          "Name": "sample string 2"
        },
        {
          "Id": "5320eb1c-7918-4342-ac17-3f41613fb5d9",
          "Name": "sample string 2"
        }
      ]
    },
    {
      "Id": "31880e59-4b6d-4da3-afa4-86dd1f5b880d",
      "Name": "sample string 2",
      "OdinVariableName": "sample string 3",
      "IsSelectionOptional": true,
      "IsMulti": true,
      "Levels": [
        {
          "Id": "5320eb1c-7918-4342-ac17-3f41613fb5d9",
          "Name": "sample string 2"
        },
        {
          "Id": "5320eb1c-7918-4342-ac17-3f41613fb5d9",
          "Name": "sample string 2"
        }
      ]
    }
  ],
  "FrameVariables": [
    {
      "Id": "bf3ca5e1-5fa3-4c37-ba25-6db41109e083",
      "DefinitionId": "2ab2cc36-8788-4ed4-af19-3acff4049016",
      "Levels": [
        {
          "Id": "4ffa9116-e2b4-4e40-818e-772aeaf5fe76",
          "DefinitionId": "78c8bd55-4868-435b-a543-f4eeb7cdbc66",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        },
        {
          "Id": "4ffa9116-e2b4-4e40-818e-772aeaf5fe76",
          "DefinitionId": "78c8bd55-4868-435b-a543-f4eeb7cdbc66",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        }
      ],
      "IsHidden": true
    },
    {
      "Id": "bf3ca5e1-5fa3-4c37-ba25-6db41109e083",
      "DefinitionId": "2ab2cc36-8788-4ed4-af19-3acff4049016",
      "Levels": [
        {
          "Id": "4ffa9116-e2b4-4e40-818e-772aeaf5fe76",
          "DefinitionId": "78c8bd55-4868-435b-a543-f4eeb7cdbc66",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        },
        {
          "Id": "4ffa9116-e2b4-4e40-818e-772aeaf5fe76",
          "DefinitionId": "78c8bd55-4868-435b-a543-f4eeb7cdbc66",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        }
      ],
      "IsHidden": true
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:
Target=1&VariableDefinitions=IEnumerable`1&FrameVariables=IEnumerable`1

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

If successful, this method returns the newly created or updated quota frame

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": "dd46ce6a-0999-4a04-81a6-50567fe0b983",
      "Name": "sample string 2",
      "OdinVariableName": "sample string 3",
      "IsSelectionOptional": true,
      "IsMulti": true,
      "Levels": [
        {
          "Id": "fbf3d0f3-3859-4894-8ec6-a1bd70cbb00f",
          "Name": "sample string 2"
        },
        {
          "Id": "fbf3d0f3-3859-4894-8ec6-a1bd70cbb00f",
          "Name": "sample string 2"
        }
      ]
    },
    {
      "Id": "dd46ce6a-0999-4a04-81a6-50567fe0b983",
      "Name": "sample string 2",
      "OdinVariableName": "sample string 3",
      "IsSelectionOptional": true,
      "IsMulti": true,
      "Levels": [
        {
          "Id": "fbf3d0f3-3859-4894-8ec6-a1bd70cbb00f",
          "Name": "sample string 2"
        },
        {
          "Id": "fbf3d0f3-3859-4894-8ec6-a1bd70cbb00f",
          "Name": "sample string 2"
        }
      ]
    }
  ],
  "FrameVariables": [
    {
      "Id": "cef0dd0b-b629-4718-9e09-3e86c6fb1a2d",
      "DefinitionId": "59773ed4-5e48-4238-a5a6-7921f3f96c04",
      "Levels": [
        {
          "Id": "2d812c10-9961-4010-82b4-defbc481058b",
          "DefinitionId": "fc1ffe3c-ea34-42da-b220-6ff995ee8a4d",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        },
        {
          "Id": "2d812c10-9961-4010-82b4-defbc481058b",
          "DefinitionId": "fc1ffe3c-ea34-42da-b220-6ff995ee8a4d",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        }
      ],
      "IsHidden": true
    },
    {
      "Id": "cef0dd0b-b629-4718-9e09-3e86c6fb1a2d",
      "DefinitionId": "59773ed4-5e48-4238-a5a6-7921f3f96c04",
      "Levels": [
        {
          "Id": "2d812c10-9961-4010-82b4-defbc481058b",
          "DefinitionId": "fc1ffe3c-ea34-42da-b220-6ff995ee8a4d",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        },
        {
          "Id": "2d812c10-9961-4010-82b4-defbc481058b",
          "DefinitionId": "fc1ffe3c-ea34-42da-b220-6ff995ee8a4d",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        }
      ],
      "IsHidden": true
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.