GET v1/Surveys/{surveyId}/SamplingPoints/{samplingPointId}/Addresses/Count

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

Permissions required to make this request: AddressCount.Read Address.Read Survey.Read

Has survey type usage restrictions capi

Returns the number of addresses at the sampling point.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

The id of the survey

string

Required

samplingPointId

The id of the samplingPoint

string

Required

Body Parameters

None.

Response Information

Resource Description

number of addresses at the sampling point

Response Message

integer

None.

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>