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

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

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

Has survey type usage restrictions capi

Activate a spare sampling point so it can be assigned. 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 spare sampling point that we want to activate	string	Required

Body Parameters

An optional target that we want to set to the sampling point

ActivateSpareSamplingPointRequestModel

Name	Description	Type	Additional information
Target	Optional. Updated spare quota target.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Target": 1
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

ActivateSpareSamplingPointsResponseModel that contains a boolean value indicating if the activation was successful

Response Message

ActivateSpareSamplingPointsResponseModel

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

Response Formats

application/json, text/json

Sample:

{
  "IsActivated": true
}

application/xml, text/xml

Sample:

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