POST 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.Write Address.Read Survey.Read

Has survey type usage restrictions capi

Add a new address to the specified sampling point.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId		string	Required
samplingPointId		string	Required

Body Parameters

AddressModel

Name	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.

Request Formats

application/json, text/json

Sample:

{
  "AddressId": "sample string 1",
  "Details": "sample string 2",
  "AppointmentDate": "2024-05-20T13:23:35.9626475+00:00",
  "SampleData": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<AddressModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <AddressId>sample string 1</AddressId>
  <AppointmentDate>2024-05-20T13:23:35.9626475+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>

application/x-www-form-urlencoded

Sample:

AddressId=sample&Details=sample&AppointmentDate=2017-01-30T12:30:00+01:00&SampleData=[]

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Message indicating the status of the request

Response Message

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.