GET v1/Surveys/{surveyId}/SamplingMethod

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser Supervisor LimitedUser LocalDomainManager GlobalDomainManager OperationsUser SampleManager DemoUser

Permissions required to make this request: SamplingMethod.Read Survey.Read

Has survey type usage restrictions capi

Method for retrieving current SamplingMethod

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId		string	Required

Body Parameters

None.

Response Information

Resource Description

Response Message

SamplingMethodModel

Name	Description	Type	Additional information
SamplingMethod	SamplingMethod type supported values: FreeIntercept, JointTargets, IndividualTargets, SamplingPoints, Addresses, AddressesWithQuota	string	None.

Response Formats

application/json, text/json

Sample:

{
  "SamplingMethod": "sample string 1"
}

application/xml, text/xml

Sample:

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