PUT v1/Surveys/{surveyId}/Sample/Update

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

Permissions required to make this request: SampleRecord.Write SampleRecord.Read Survey.Read

Updates Sample Record

Request Information

URI Parameters

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

Body Parameters

model with the sample record id to edit and the custom columns to be changed

SurveyUpdateSampleRecordModel

Name	Description	Type	Additional information
SampleRecordId	The unique id of the sample record	integer	None.
ColumnUpdates	Custom columns to be updated	Collection of SampleColumnUpdate	None.

Request Formats

application/json, text/json

Sample:

{
  "SampleRecordId": 1,
  "ColumnUpdates": [
    {
      "ColumnName": "sample string 1",
      "Value": {}
    },
    {
      "ColumnName": "sample string 1",
      "Value": {}
    }
  ]
}

application/xml, text/xml

Sample:

<SurveyUpdateSampleRecordModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <ColumnUpdates xmlns:d2p1="http://schemas.datacontract.org/2004/07/Nfield.Manager.SurveysAndSampleManagement.Common.Models">
    <d2p1:SampleColumnUpdate>
      <d2p1:ColumnName>sample string 1</d2p1:ColumnName>
      <d2p1:Value />
    </d2p1:SampleColumnUpdate>
    <d2p1:SampleColumnUpdate>
      <d2p1:ColumnName>sample string 1</d2p1:ColumnName>
      <d2p1:Value />
    </d2p1:SampleColumnUpdate>
  </ColumnUpdates>
  <SampleRecordId>1</SampleRecordId>
</SurveyUpdateSampleRecordModel>

application/x-www-form-urlencoded

Sample:

[SampleRecordId=1&ColumnUpdates=IEnumerable`1]

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

true if success, false otherwise

Response Message

SampleUpdateStatus

Name	Description	Type	Additional information
ResultStatus	result of the update operation	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ResultStatus": true
}

application/xml, text/xml

Sample:

<SampleUpdateStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <ResultStatus>true</ResultStatus>
</SampleUpdateStatus>