Create a Questionnaire Title and Description
post
/spms/v1/questionnaires/templates/{id}/titles
This is to create questionnaire title and description
Request
Supported Media Types
- application/json
Path Parameters
Required to create Questionnare Title
Root Schema : CreateQuestionnaireTitle
Type:
object
Create Questionnaire Title
Show Source
-
description(optional):
object description
-
templateId(optional):
integer
Minimum Value:
1
Maximum Value:9999
This value is the primary id value obtained from Questionnaire Template tableExample:1
-
title:
object title
Nested Schema : description
Type:
Show Source
object
-
default(optional):
string
Minimum Length:
1
Maximum Length:255
Example:Oracle Cruise Group
-
zh(optional):
string
Minimum Length:
1
Maximum Length:255
Example:甲骨文克鲁斯集团
Nested Schema : title
Type:
Show Source
object
-
default(optional):
string
Minimum Length:
1
Maximum Length:255
Example:Oracle Cruise Group
-
zh(optional):
string
Minimum Length:
1
Maximum Length:255
Example:甲骨文克鲁斯集团
Response
Supported Media Types
- application/json
201 Response
Created
Root Schema : QuestionnaireTitle
Type:
object
Title:
QuestionnaireTitle
Questionnaire Title details
Show Source
-
description(optional):
object description
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9999
This value is the primary id value obtained from Questionnaire Title tableExample:1
-
templateId(optional):
integer
Minimum Value:
1
Maximum Value:9999
This value is the primary id value obtained from Questionnaire Template tableExample:1
-
title(optional):
object title
Nested Schema : description
Type:
Show Source
object
-
default(optional):
string
Minimum Length:
1
Maximum Length:255
Example:Oracle Cruise Group
-
zh(optional):
string
Minimum Length:
1
Maximum Length:255
Example:甲骨文克鲁斯集团
Nested Schema : title
Type:
Show Source
object
-
default(optional):
string
Minimum Length:
1
Maximum Length:255
Example:Oracle Cruise Group
-
zh(optional):
string
Minimum Length:
1
Maximum Length:255
Example:甲骨文克鲁斯集团
400 Response
Bad Request
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Bad Request",
"detail":"The parameter templateId has incorrect format"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
401 Response
Unauthorized
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
"title":"Unauthorized",
"detail":"Valid token is required to access this resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
403 Response
Forbidden
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
"title":"Forbidden",
"detail":"Access to this resource was forbidden"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
404 Response
Not Found
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
"title":"Not Found",
"detail":"Template not found"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
405 Response
Method Not Allowed
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
"title":"Method Not Allowed",
"detail":"HTTP method not supported for this resource"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
406 Response
Not Acceptable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
"title":"Not Acceptable",
"detail":"The Questionnaire Title is in use"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
409 Response
Conflict
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
"title":"Conflict",
"detail":"You are trying to create a questionnaire title that exist"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
415 Response
Unsupported Media Type
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
"title":"Invalid content",
"detail":"Content type not supported"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
500 Response
Internal Server Error
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
"title":"Internal Server Error",
"detail":"Issue fulfilling request. Please retry or contact support"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
503 Response
Service Unavailable
Root Schema : schema
Match All
Show Source
-
object
Error Response
Title:
Error Response
Error Response returned when encountered error
Example:
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
"title":"Service Unavailable",
"detail":"Service Unavailable. Try again later"
}
Nested Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source