GET v1/Surveys/{surveyId}/Publish

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

Gets the publish state of the survey in the context.

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

Returns Survey package publish state.

Response Message

SurveyPackageStateModel

Name	Description	Type	Additional information
Live	The state of the package for live interviewing	PackagePublishState	None.
Test	The state of the package for test interviewing	PackagePublishState	None.

Response Formats

application/json, text/json

Sample:

{
  "Live": 0,
  "Test": 0
}

application/xml, text/xml

Sample:

<SurveyPackageStateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Live>Unknown</Live>
  <Test>Unknown</Test>
</SurveyPackageStateModel>