POST v1/Surveys/{surveyId}/Publish/Start

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

Permissions required to make this request: Survey.Publish.Live Survey.Publish.Test Survey.Read

Has survey type usage restrictions online

Creates an activity that starts the publishing process. Use the activity id to wait for the publish result.

Request Information

URI Parameters

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

Body Parameters

A model that handels the interview package type and force interviews on older packages to upgrade to this package

SurveyPublishTypeUpgradeModel

Name	Description	Type	Additional information
PackageType	The Interview Package Type	InterviewPackageType	None.
ForceUpgrade	The state of published new package if upgrade for current interviews needed	PackageForceUpgrade	None.

Request Formats

application/json, text/json

Sample:

{
  "PackageType": 0,
  "ForceUpgrade": 0
}

application/xml, text/xml

Sample:

<SurveyPublishTypeUpgradeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <ForceUpgrade>NoUpgrade</ForceUpgrade>
  <PackageType>Unknown</PackageType>
</SurveyPublishTypeUpgradeModel>

application/x-www-form-urlencoded

Sample:

PackageType=Live&ForceUpgrade=NoUpgrade

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Message indicating successful Survey publishing.

Response Message

BackgroundActivityStatus

Name	Description	Type	Additional information
ActivityId	The id of the started activity	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ActivityId": "sample string 1"
}

application/xml, text/xml

Sample:

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