GET v1/Surveys/{surveyId}/Settings
User roles allowed to make this request:
DomainAdministrator
PowerUser
RegularUser
Supervisor
Scripter
LimitedUser
QuotaManager
LocalDomainManager
GlobalDomainManager
OperationsUser
SampleManager
RepositoryManager
DemoUser
All
Permissions required to make this request:
Survey.Read
This method retrieves the settings for the survey with the specified surveyId.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
surveyId |
The id of the survey |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
A (filtered) list of survey settings
Response Message
Collection of SurveySettingModelName | Description | Type | Additional information |
---|---|---|---|
Name |
The name |
string |
Required Max length: 50 |
Value |
The value |
string |
Max length: 512 |
Response Formats
application/json, text/json
[ { "Name": "sample string 1", "Value": "sample string 2" }, { "Name": "sample string 1", "Value": "sample string 2" } ]
application/xml, text/xml
<ArrayOfSurveySettingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models"> <SurveySettingModel> <Name>sample string 1</Name> <Value>sample string 2</Value> </SurveySettingModel> <SurveySettingModel> <Name>sample string 1</Name> <Value>sample string 2</Value> </SurveySettingModel> </ArrayOfSurveySettingModel>