GET v1/Surveys/{surveyId}/SamplingPoints

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

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

Has survey type usage restrictions capi

Get a list of all sampling points for a survey. This list can be filtered and sorted using standard OData syntax.

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

Returns a list of Sampling Point for the survey

Response Message

Collection of SamplingPointModel

Name	Description	Type	Additional information
SamplingPointId	Gets or sets the sampling point unique identifier.	string	String length: inclusive between 0 and 128
Name	Gets or sets the name of the sampling point.	string	Required
Description	Gets or sets the description.	string	String length: inclusive between 0 and 4096
Instruction	Gets or sets the instruction link, this is a link to a pdf blob storage.	string	String length: inclusive between 0 and 2147483647
FieldworkOfficeId	Gets or sets the associcated fieldwork office id.	string	String length: inclusive between 0 and 36
GroupId	Gets or sets the group id.	string	String length: inclusive between 0 and 128
Stratum	Stratum the sampling point belongs to	string	String length: inclusive between 0 and 128
Kind	Indicates the Kind of the sampling point. The only accepted values are "Regular" and "Spare". If the value is null then we assign this as "Regular" to be backward compatible	SamplingPointKind	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SamplingPointId": "sample string 1",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "Instruction": "sample string 4",
    "FieldworkOfficeId": "sample string 5",
    "GroupId": "sample string 6",
    "Stratum": "sample string 7",
    "Kind": 0
  },
  {
    "SamplingPointId": "sample string 1",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "Instruction": "sample string 4",
    "FieldworkOfficeId": "sample string 5",
    "GroupId": "sample string 6",
    "Stratum": "sample string 7",
    "Kind": 0
  }
]

application/xml, text/xml

Sample:

<ArrayOfSamplingPointModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <SamplingPointModel>
    <Description>sample string 3</Description>
    <FieldworkOfficeId>sample string 5</FieldworkOfficeId>
    <GroupId>sample string 6</GroupId>
    <Instruction>sample string 4</Instruction>
    <Kind>Regular</Kind>
    <Name>sample string 2</Name>
    <SamplingPointId>sample string 1</SamplingPointId>
    <Stratum>sample string 7</Stratum>
  </SamplingPointModel>
  <SamplingPointModel>
    <Description>sample string 3</Description>
    <FieldworkOfficeId>sample string 5</FieldworkOfficeId>
    <GroupId>sample string 6</GroupId>
    <Instruction>sample string 4</Instruction>
    <Kind>Regular</Kind>
    <Name>sample string 2</Name>
    <SamplingPointId>sample string 1</SamplingPointId>
    <Stratum>sample string 7</Stratum>
  </SamplingPointModel>
</ArrayOfSamplingPointModel>