PUT v1/Surveys/{surveyId}/SurveyQuotaFrame/{eTag}

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

Updates the survey quota targets for the specified quota frame version

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The survey to set the quota targets for	string	Required
eTag	The quota frame version to set the targets for	string	Required

Body Parameters

The new quota frame targets

SurveyQuotaFrameEtagRequestModel

Name	Description	Type	Additional information
Levels		Collection of SurveyQuotaFrameEtagLevelTargetModel	None.

Request Formats

application/json, text/json

Sample:

{
  "Levels": [
    {
      "Id": "sample string 1",
      "Target": 1,
      "MaxTarget": 1,
      "MaxOvershoot": 1
    },
    {
      "Id": "sample string 1",
      "Target": 1,
      "MaxTarget": 1,
      "MaxOvershoot": 1
    }
  ]
}

application/xml, text/xml

Sample:

<SurveyQuotaFrameEtagRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.SurveyQuotaFrame">
  <Levels>
    <SurveyQuotaFrameEtagLevelTargetModel>
      <Id>sample string 1</Id>
      <MaxOvershoot>1</MaxOvershoot>
      <MaxTarget>1</MaxTarget>
      <Target>1</Target>
    </SurveyQuotaFrameEtagLevelTargetModel>
    <SurveyQuotaFrameEtagLevelTargetModel>
      <Id>sample string 1</Id>
      <MaxOvershoot>1</MaxOvershoot>
      <MaxTarget>1</MaxTarget>
      <Target>1</Target>
    </SurveyQuotaFrameEtagLevelTargetModel>
  </Levels>
</SurveyQuotaFrameEtagRequestModel>

application/x-www-form-urlencoded

Sample:

Levels=IEnumerable`1

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Response Message

SurveyQuotaFrameEtagResponseModel

Name	Description	Type	Additional information
Levels		Collection of SurveyQuotaFrameEtagLevelTargetModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Levels": [
    {
      "Id": "sample string 1",
      "Target": 1,
      "MaxTarget": 1,
      "MaxOvershoot": 1
    },
    {
      "Id": "sample string 1",
      "Target": 1,
      "MaxTarget": 1,
      "MaxOvershoot": 1
    }
  ]
}

application/xml, text/xml

Sample:

<SurveyQuotaFrameEtagResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.SurveyQuotaFrame">
  <Levels>
    <SurveyQuotaFrameEtagLevelTargetModel>
      <Id>sample string 1</Id>
      <MaxOvershoot>1</MaxOvershoot>
      <MaxTarget>1</MaxTarget>
      <Target>1</Target>
    </SurveyQuotaFrameEtagLevelTargetModel>
    <SurveyQuotaFrameEtagLevelTargetModel>
      <Id>sample string 1</Id>
      <MaxOvershoot>1</MaxOvershoot>
      <MaxTarget>1</MaxTarget>
      <Target>1</Target>
    </SurveyQuotaFrameEtagLevelTargetModel>
  </Levels>
</SurveyQuotaFrameEtagResponseModel>