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

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

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

Has survey type usage restrictions online cati

Blocks sample data for a survey based on the survey id and a filter.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The survey's ID	string	Required

Body Parameters

[MANDATORY] Filters to be applied for the block operation

Collection of SampleFilterModel

Name	Description	Type	Additional information
Name	Name of a field in a sample record	string	Required
Op	Operator, supported operators: "strt": starts with, "con" : contains, "ncon": not contains, "eq" : equals, "lt" : less than, "gt" : greater than, "lte" : less or equal, "gte" : greater or equal, "neq" : not equal, "in" : in - value should be a comma-separated list of values	string	Required
Value	Value	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "Name": "sample string 1",
    "Op": "sample string 2",
    "Value": "sample string 3"
  },
  {
    "Name": "sample string 1",
    "Op": "sample string 2",
    "Value": "sample string 3"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSampleFilterModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <SampleFilterModel>
    <Name>sample string 1</Name>
    <Op>sample string 2</Op>
    <Value>sample string 3</Value>
  </SampleFilterModel>
  <SampleFilterModel>
    <Name>sample string 1</Name>
    <Op>sample string 2</Op>
    <Value>sample string 3</Value>
  </SampleFilterModel>
</ArrayOfSampleFilterModel>

application/x-www-form-urlencoded

Sample:

[Name=sample&Op=sample&Value=sample]

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

The id of the background activity you can use to get the results.

Response Message

BackgroundActivityStatus

Name	Description	Type	Additional information
ActivityId	The id of the started activity	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ActivityId": "sample string 1"
}

application/xml, text/xml

Sample:

<BackgroundActivityStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <ActivityId>sample string 1</ActivityId>
</BackgroundActivityStatus>