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

SurveyQuotaFrameRequestModel

Name	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

Sample:

{
  "Target": 1,
  "VariableDefinitions": [
    {
      "Id": "3579556e-1650-47b7-91fe-92e4df6b4eb5",
      "Name": "sample string 2",
      "OdinVariableName": "sample string 3",
      "IsSelectionOptional": true,
      "IsMulti": true,
      "Levels": [
        {
          "Id": "43d9f91a-5ff4-4e6b-9552-84d2892b48f8",
          "Name": "sample string 2"
        },
        {
          "Id": "43d9f91a-5ff4-4e6b-9552-84d2892b48f8",
          "Name": "sample string 2"
        }
      ]
    },
    {
      "Id": "3579556e-1650-47b7-91fe-92e4df6b4eb5",
      "Name": "sample string 2",
      "OdinVariableName": "sample string 3",
      "IsSelectionOptional": true,
      "IsMulti": true,
      "Levels": [
        {
          "Id": "43d9f91a-5ff4-4e6b-9552-84d2892b48f8",
          "Name": "sample string 2"
        },
        {
          "Id": "43d9f91a-5ff4-4e6b-9552-84d2892b48f8",
          "Name": "sample string 2"
        }
      ]
    }
  ],
  "FrameVariables": [
    {
      "Id": "d027c950-2734-478b-93c8-3d01c0dcf230",
      "DefinitionId": "40bf6256-b10c-4931-8cd5-9a70ca334b3e",
      "Levels": [
        {
          "Id": "ea8e5f87-69ab-4f00-afdd-481cf82e90da",
          "DefinitionId": "acd4e1df-d412-4e7d-8e6f-36e5f09b9f54",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        },
        {
          "Id": "ea8e5f87-69ab-4f00-afdd-481cf82e90da",
          "DefinitionId": "acd4e1df-d412-4e7d-8e6f-36e5f09b9f54",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        }
      ],
      "IsHidden": true
    },
    {
      "Id": "d027c950-2734-478b-93c8-3d01c0dcf230",
      "DefinitionId": "40bf6256-b10c-4931-8cd5-9a70ca334b3e",
      "Levels": [
        {
          "Id": "ea8e5f87-69ab-4f00-afdd-481cf82e90da",
          "DefinitionId": "acd4e1df-d412-4e7d-8e6f-36e5f09b9f54",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        },
        {
          "Id": "ea8e5f87-69ab-4f00-afdd-481cf82e90da",
          "DefinitionId": "acd4e1df-d412-4e7d-8e6f-36e5f09b9f54",
          "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

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": "012ba881-fbca-4ede-a411-50a8beec4f79",
      "Name": "sample string 2",
      "OdinVariableName": "sample string 3",
      "IsSelectionOptional": true,
      "IsMulti": true,
      "Levels": [
        {
          "Id": "82710580-b3a4-4b70-b83e-2b4b56dcb9ba",
          "Name": "sample string 2"
        },
        {
          "Id": "82710580-b3a4-4b70-b83e-2b4b56dcb9ba",
          "Name": "sample string 2"
        }
      ]
    },
    {
      "Id": "012ba881-fbca-4ede-a411-50a8beec4f79",
      "Name": "sample string 2",
      "OdinVariableName": "sample string 3",
      "IsSelectionOptional": true,
      "IsMulti": true,
      "Levels": [
        {
          "Id": "82710580-b3a4-4b70-b83e-2b4b56dcb9ba",
          "Name": "sample string 2"
        },
        {
          "Id": "82710580-b3a4-4b70-b83e-2b4b56dcb9ba",
          "Name": "sample string 2"
        }
      ]
    }
  ],
  "FrameVariables": [
    {
      "Id": "86a15f41-c1a4-4586-8280-a31c1207280e",
      "DefinitionId": "2aaab7ae-6884-4c0c-b716-cb251290268e",
      "Levels": [
        {
          "Id": "8b912fce-63c4-4128-8da3-32b51d187309",
          "DefinitionId": "227baa7a-7dc7-49a3-ae82-49d0cf38d917",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        },
        {
          "Id": "8b912fce-63c4-4128-8da3-32b51d187309",
          "DefinitionId": "227baa7a-7dc7-49a3-ae82-49d0cf38d917",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        }
      ],
      "IsHidden": true
    },
    {
      "Id": "86a15f41-c1a4-4586-8280-a31c1207280e",
      "DefinitionId": "2aaab7ae-6884-4c0c-b716-cb251290268e",
      "Levels": [
        {
          "Id": "8b912fce-63c4-4128-8da3-32b51d187309",
          "DefinitionId": "227baa7a-7dc7-49a3-ae82-49d0cf38d917",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        },
        {
          "Id": "8b912fce-63c4-4128-8da3-32b51d187309",
          "DefinitionId": "227baa7a-7dc7-49a3-ae82-49d0cf38d917",
          "Target": 1,
          "MaxTarget": 1,
          "MaxOvershoot": 1,
          "Variables": [],
          "IsHidden": true
        }
      ],
      "IsHidden": true
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.