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
ActivateSpareSamplingPointRequestModelName | Description | Type | Additional information |
---|---|---|---|
Target |
Optional. Updated spare quota target. |
integer |
None. |
Request Formats
application/json, text/json
{ "Target": 1 }
application/xml, text/xml
<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
multipart/form-data
Sample not available.
Response Information
Resource Description
ActivateSpareSamplingPointsResponseModel that contains a boolean value indicating if the activation was successful
Response Message
ActivateSpareSamplingPointsResponseModelName | Description | Type | Additional information |
---|---|---|---|
IsActivated |
true if the activation was successful |
boolean |
None. |
Response Formats
application/json, text/json
{ "IsActivated": true }
application/xml, text/xml
<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>