GET v1/Surveys/{surveyId}/SamplingPoints/{samplingPointId}/QuotaTargets

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

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

Has survey type usage restrictions capi

This method retrieves a list of quota level targets based on survey and sampling point.

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

Body Parameters

None.

Response Information

Resource Description

Returns a list of quota level targets

Response Message

Collection of SamplingPointQuotaTargetModel

Name	Description	Type	Additional information
LevelId	The Id of the Quota Level that sits in the Quota JSON structure	string	None.
Target	Actual target of the level	integer	None.
SuccessfulCount	Number of successfully completed interviews	integer	None.
UnsuccessfulCount	Number of not successfully completed interviews	integer	None.
DroppedOutCount	Number of dropped out interviews	integer	None.
RejectedCount	Number of dropped out interviews	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "LevelId": "sample string 1",
    "Target": 1,
    "SuccessfulCount": 2,
    "UnsuccessfulCount": 3,
    "DroppedOutCount": 4,
    "RejectedCount": 5
  },
  {
    "LevelId": "sample string 1",
    "Target": 1,
    "SuccessfulCount": 2,
    "UnsuccessfulCount": 3,
    "DroppedOutCount": 4,
    "RejectedCount": 5
  }
]

application/xml, text/xml

Sample:

<ArrayOfSamplingPointQuotaTargetModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <SamplingPointQuotaTargetModel>
    <DroppedOutCount>4</DroppedOutCount>
    <LevelId>sample string 1</LevelId>
    <RejectedCount>5</RejectedCount>
    <SuccessfulCount>2</SuccessfulCount>
    <Target>1</Target>
    <UnsuccessfulCount>3</UnsuccessfulCount>
  </SamplingPointQuotaTargetModel>
  <SamplingPointQuotaTargetModel>
    <DroppedOutCount>4</DroppedOutCount>
    <LevelId>sample string 1</LevelId>
    <RejectedCount>5</RejectedCount>
    <SuccessfulCount>2</SuccessfulCount>
    <Target>1</Target>
    <UnsuccessfulCount>3</UnsuccessfulCount>
  </SamplingPointQuotaTargetModel>
</ArrayOfSamplingPointQuotaTargetModel>