POST v1/Surveys/{surveyId}/Settings

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

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

This method add settings for specified surveyId. Update settings if it's already created.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

The id of the survey

 string

Required

Body Parameters

An object describing the details for the settings

SurveySettingModel
NameDescriptionTypeAdditional information
Name

The name

 string

Required

Max length: 50
Value

The value

 string

Max length: 512

Request Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "Value": "sample string 2"
}

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample: 
Name=sample&Value=sample

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Response Message

SurveySettingModel
NameDescriptionTypeAdditional information
Name

The name

 string

Required

Max length: 50
Value

The value

 string

Max length: 512

Response Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "Value": "sample string 2"
}

application/xml, text/xml

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