POST v1/Surveys/{surveyId}/ActivateSamplingPoints

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

Send a list of spare sampling points to be activated so they can be assigned.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The id of the survey	string	Required

Body Parameters

A list of spare sampling points that we request to activate

ActivateSpareSamplingPointsRequestModel

Name	Description	Type	Additional information
SamplingPointIds	Spare sampling points that need to be activated	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "SamplingPointIds": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ActivateSpareSamplingPointsRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.SurveySamplingPoints">
  <SamplingPointIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SamplingPointIds>
</ActivateSpareSamplingPointsRequestModel>

application/x-www-form-urlencoded

Sample:

SamplingPointIds=IEnumerable`1

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>