GET v1/Surveys/{surveyId}

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

Supports blueprint surveys

Supports survey simulations

This method retrieve details of a specific survey.

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

The details of the survey

Response Message

SurveyModel

Name	Description	Type	Additional information
ClientName	Gets or sets the name of the client, e.g. Coca Cola.	string	Max length: 50
SurveyType	Gets or sets the type of the survey.	string	Required
Description	The description of the survey	string	Max length: 4096
QuestionnaireMD5	The Md5 hash of the current (compiled) questionnaire	string	Max length: 128
InterviewerInstruction	The default interviewer instruction of a survey	string	Max length: 2147483647
SurveyState	The current state of a survey	SurveyState	None.
SurveyGroupId	The survey group this survey belongs to	integer	None.
IsBlueprint	True if this survey is a blueprint, otherwise false.	boolean	None.
EnableRespondentsGateway	Indication that this survey sample can be managed by the Respondents Gateway	boolean	None.
SurveyId	The unique id of the survey	string	Max length: 36
SurveyName	The name of the survey	string	Required Max length: 50

Response Formats

application/json, text/json

Sample:

{
  "ClientName": "sample string 1",
  "SurveyType": "sample string 2",
  "Description": "sample string 3",
  "QuestionnaireMD5": "sample string 4",
  "InterviewerInstruction": "sample string 5",
  "SurveyState": 0,
  "SurveyGroupId": 6,
  "IsBlueprint": true,
  "EnableRespondentsGateway": true,
  "SurveyId": "sample string 9",
  "SurveyName": "sample string 10"
}

application/xml, text/xml

Sample:

<SurveyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <SurveyId>sample string 9</SurveyId>
  <SurveyName>sample string 10</SurveyName>
  <ClientName>sample string 1</ClientName>
  <Description>sample string 3</Description>
  <EnableRespondentsGateway>true</EnableRespondentsGateway>
  <InterviewerInstruction>sample string 5</InterviewerInstruction>
  <IsBlueprint>true</IsBlueprint>
  <QuestionnaireMD5>sample string 4</QuestionnaireMD5>
  <SurveyGroupId>6</SurveyGroupId>
  <SurveyState>UnderConstruction</SurveyState>
  <SurveyType>sample string 2</SurveyType>
</SurveyModel>