PATCH v1/Surveys/{surveyId}/SamplingPoints/{samplingPointId}/QuotaTargets/{quotaLevelId}

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser LimitedUser SampleManager

Permissions required to make this request: SamplingPointQuotaTarget.Write SamplingPointQuotaTarget.Read SamplingPoint.Read Survey.Read SurveyQuotaFrame.Read

Has survey type usage restrictions capi

Update an sampling point's quota level with the specified fields.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The id of the survey	string	Required
samplingPointId	The id of the sampling point	string	Required
quotaLevelId	The id of the quota level	string	Required

Body Parameters

Supply SamplingPointQuotaLevelTarget object with only the properties and values you would like to update. Only the Target property can be supplied.

SamplingPointQuotaLevelTargetModel

Name	Description	Type	Additional information
SurveyId	The survey id for the survey associated to this quota level	string	None.
SamplingPointId	The sampling point id for the sampling point associated to this quota level	string	None.
LevelId	The Id of the Quota Level that sits in the Quota JSON structure	string	None.
Target	Actual target of the level	integer	None.
MaxTarget	Maximum Target is NOT implemented	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Target": 100
}

application/xml, text/xml

Sample:

<SamplingPointQuotaLevelTarget xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Target>100</Target>
</SamplingPointQuotaLevelTarget>

application/x-www-form-urlencoded

Sample:

No sample available

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

The updated details of the sampling point quota level

Response Message

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.