Skip to content

getSurveyStatusInfo ​

Returns basic info about a Survey (SmartForm) such as status and retired data such that this info can be used by the client app to provide more options and info.

Request ​

http
GET /rest/survey/info

Headers ​

NOTE: this does not currently require authentication BUT should eventually

Parameters ​

ParameterTypeRequiredDescription
surveyUUID-YesA UUID of a valid Survey/SmartForm
bId-NoBrochure Id (Asset Id) of asset related to SmartForm being submitted
bvId-NoBrochure Version Id (Asset Version Id) of asset version related to SmartForm being submitted

Response ​

200 OK ​

json
{
  "bId": 1,
  "surveyId": 1,
  "bvStatusName": "Active",
  "bvId": 2,
  "surveyUUID": "550e8400-e29b-41d4-a716-446655440000",
  "surveyRetired": 1459818393000,
  "surveyStatus": "Active",
  "bStatusName": "Active"
}

Errors ​

ExceptionDescription
WSSurveyNotFoundExceptionSee Error Definitions
WSInvalidParameterExceptionSee Error Definitions
WSSurveyServiceExceptionSee Error Definitions