(Quick Reference) Service: Create a survey

Description: this web service is used in order to create a survey and added into the data base and finally returns the created instance in JSON format.



Method: POST

Request content type: application/json


NameDescriptionTypeRequiredPossible values
namethe name of the surveyStringyes 
descriptionit contains the description of the surveyStringno 
enabledIt indicates the status of the surveyBooleannotrue, false
isPublicit indicate if the survey is destined to a specified users or notBooleannotrue, false
usersthe list of users for private surveyList-[18,19]
answerOnceIt indicated if the survey can be answered just one time or not set to true by defaultBooleannotrue, false
showAllAtOnceIt indicated if the survey questions will be showed all at once or not set to false by defaultBooleannotrue, false
useExternalIdBy default, it is set to false. set it to true if you want to use external ids.Booleannotrue , false

the default value of enabled and isPublic is set to false

Success Output

Success case: response.status = 201

    "id": 71,
    "name": "Survey of quality",
    "description": "this survey contains some questions about the quality of our product",
    "isPublic": false,
    "status": true,
    "organization": "entity1",
    "dateCreated": "2016-08-31T16:10:21Z",
    "lastUpdated": "2016-08-31T16:10:21Z",
    "answerOnce": true,
    "showAllAtOnce": false,
    "users": [
            "id": 3,
            "reference": "R002",
            "firstName": "LUFY",
            "lastName": "MONKEYD",
            "href": "/api/v1.0/users/3"
            "id": 2,
            "reference": "R001",
            "firstName": "SADOK",
            "lastName": "CHEBIL",
            "href": "/api/v1.0/users/2"
    "questions": []

Failure Output

Failure case:response.status = 400

    "error": "missing_param",
    "error_description": "name parameter is missing"
  "error": "invalid_param_type",
  "error_description": "An invalid value was specified for parameter: answerOnce (must be Boolean)"
    "error": "invalid_param_type",
    "error_description": "The type of parameter users you provided is not valid for this request."
	"error": "save_failed",
 	"error_description": "Failed to save instance"

Failure case:response.status = 404

    "error": "not_found",
    "error_description": "The user with the id 999 doesn't exist."

Failure case:response.status = 500
    "error": "server_error",
    "error_description": "Oops! Something went wrong..."