PATCH v1/Surveys/{surveyId}/SamplingMethod
User roles allowed to make this request:
DomainAdministrator
PowerUser
RegularUser
Supervisor
LimitedUser
SampleManager
Permissions required to make this request:
SamplingMethod.Write
SamplingMethod.Read
Survey.Read
Has survey type usage restrictions capi
Method for saving the SamplingMethod
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
surveyId | string |
Required |
Body Parameters
SamplingMethodModelName | Description | Type | Additional information |
---|---|---|---|
SamplingMethod |
SamplingMethod type supported values: FreeIntercept, JointTargets, IndividualTargets, SamplingPoints, Addresses, AddressesWithQuota |
string |
None. |
Request Formats
application/json, text/json
{ "SamplingMethod": "sample string 1" }
application/xml, text/xml
<SamplingMethodModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models"> <SamplingMethod>sample string 1</SamplingMethod> </SamplingMethodModel>
application/x-www-form-urlencoded
SamplingMethod=sample
multipart/form-data
Sample not available.
Response Information
Resource Description
Response Message
HttpResponseMessageName | Description | 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. |