POST v1/Surveys/CreateSurveyFromBlueprint

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

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

Supports blueprint surveys

This method creates a new survey from a blueprint survey. All survey configurations will be copied from the blueprint to the new survey.

Request Information

URI Parameters

None.

Body Parameters

An object describing the details for the new survey

SurveyFromBlueprintModel
NameDescriptionTypeAdditional information
SurveyName

The name for the new survey

string

None.

BlueprintSurveyId

The id for the blueprint survey

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SurveyName": "sample string 1",
  "BlueprintSurveyId": "sample string 2"
}

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:
SurveyName=sample&BlueprintSurveyId=sample

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

If successful, this method returns the newly created survey

Response Message

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.