POST v1/ParentSurveys/Waves

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

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

Creates a new wave survey and copies artifacts from existing wave.

Request Information

URI Parameters

None.

Body Parameters

The survey model

SurveyWaveCopyModel

Name	Description	Type	Additional information
SourceWaveId	The wave Id to copy artifacts from	string	None.
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

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

If successful, the method returns a new wave survey

Response Message

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.