PATCH v1/Surveys/{surveyId}/SamplingPoints/{samplingPointId}/Replace

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

Permissions required to make this request: SamplingPoint.Write SamplingPoint.Read Survey.Read FieldworkOffice.Read SurveyInterviewerAssignment.Write SurveyInterviewerAssignment.Read Interviewer.Read SurveyQuotaFrame.Read SurveyInterviewSetting.Read

Has survey type usage restrictions capi

Replaces an active sampling point with a spare one. If a target is provided, it will also apply it.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The id of the survey	string	Required
samplingPointId	The id of the sampling point that we want to replace	string	Required

Body Parameters

The sampling point id and target of the spare that we want to use as replacement

ReplaceSamplingPointWithSpareRequestModel

Name	Description	Type	Additional information
SpareSamplingPointId	The id of the Spare sampling point that will replace the existing one	string	None.
Target	Optional. Updated spare quota target.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "SpareSamplingPointId": "sample string 1",
  "Target": 1
}

application/xml, text/xml

Sample:

<ReplaceSamplingPointWithSpareRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.SurveySamplingPoints">
  <SpareSamplingPointId>sample string 1</SpareSamplingPointId>
  <Target>1</Target>
</ReplaceSamplingPointWithSpareRequestModel>

application/x-www-form-urlencoded

Sample:

SpareSamplingPointId=sample&Target=1

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

A boolean indicating if the replacement was successful

Response Message

ReplaceSamplingPointWithSpareResponseModel

Name	Description	Type	Additional information
Success	true if the activation was successful	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true
}

application/xml, text/xml

Sample:

<ReplaceSamplingPointWithSpareResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.SurveySamplingPoints">
  <Success>true</Success>
</ReplaceSamplingPointWithSpareResponseModel>