Appearance
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/infoHeaders ​
NOTE: this does not currently require authentication BUT should eventually
Parameters ​
| Parameter | Type | Required | Description |
|---|---|---|---|
surveyUUID | - | Yes | A UUID of a valid Survey/SmartForm |
bId | - | No | Brochure Id (Asset Id) of asset related to SmartForm being submitted |
bvId | - | No | Brochure 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 ​
| Exception | Description |
|---|---|
WSSurveyNotFoundException | See Error Definitions |
WSInvalidParameterException | See Error Definitions |
WSSurveyServiceException | See Error Definitions |