GET v1/Surveys/{surveyId}/SamplingPoints/{samplingPointId}/Addresses
User roles allowed to make this request:
DomainAdministrator
PowerUser
RegularUser
LimitedUser
SampleManager
Permissions required to make this request:
Address.Read
Survey.Read
Has survey type usage restrictions capi
This method retrieves a list of Addresses. This list can be filtered and sorted using standard OData syntax.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
surveyId | string |
Required |
|
samplingPointId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
A (filtered) list of addresses
Response Message
Collection of AddressModelName | Description | Type | Additional information |
---|---|---|---|
AddressId |
Unique id of the address |
string |
Max length: 128 |
Details |
Details of the address |
string |
Max length: 2147483647 |
AppointmentDate |
Appointment Date of the address |
date |
None. |
SampleData |
SampleData variables for Odin |
Collection of AddressSampleDataModel |
None. |
Response Formats
application/json, text/json
[ { "AddressId": "sample string 1", "Details": "sample string 2", "AppointmentDate": "2024-09-03T19:05:31.3373371+00:00", "SampleData": [ { "Name": "sample string 1", "Value": "sample string 2" }, { "Name": "sample string 1", "Value": "sample string 2" } ] }, { "AddressId": "sample string 1", "Details": "sample string 2", "AppointmentDate": "2024-09-03T19:05:31.3373371+00:00", "SampleData": [ { "Name": "sample string 1", "Value": "sample string 2" }, { "Name": "sample string 1", "Value": "sample string 2" } ] } ]
application/xml, text/xml
<ArrayOfAddressModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models"> <AddressModel> <AddressId>sample string 1</AddressId> <AppointmentDate>2024-09-03T19:05:31.3373371+00:00</AppointmentDate> <Details>sample string 2</Details> <SampleData> <AddressSampleDataModel> <Name>sample string 1</Name> <Value>sample string 2</Value> </AddressSampleDataModel> <AddressSampleDataModel> <Name>sample string 1</Name> <Value>sample string 2</Value> </AddressSampleDataModel> </SampleData> </AddressModel> <AddressModel> <AddressId>sample string 1</AddressId> <AppointmentDate>2024-09-03T19:05:31.3373371+00:00</AppointmentDate> <Details>sample string 2</Details> <SampleData> <AddressSampleDataModel> <Name>sample string 1</Name> <Value>sample string 2</Value> </AddressSampleDataModel> <AddressSampleDataModel> <Name>sample string 1</Name> <Value>sample string 2</Value> </AddressSampleDataModel> </SampleData> </AddressModel> </ArrayOfAddressModel>