Jump to

• Request
• Response

Update a Question group

put

/spms/v1/questionnaires/templates/{templateId}/questionGroups/{groupId}

This is to update the Question group properties by passing in a json object.

Request

Supported Media Types

• application/json

Path Parameters

• groupId: integer
  Primary key that can be obtain from Questionnaire Question Group Table Primary Key
• templateId: integer
  Primary key that can be obtain from Questionnaire Template Table Primary Key

Body ()

Required to update Question Group

Root Schema : UpdateQuestionGroup

Type: object

Questionnaire Question Group

Show Source

• group(optional): object group
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9999

  This value is the primary id value obtained from Question Group table

  Example: 1
• templateId(optional): integer
  Minimum Value: 1

  Maximum Value: 9999

  This value is the primary id value obtained from Questionnaire Template table

  Example: 1

{
    "description":"Questionnaire Question Group",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1,
            "maximum":9999,
            "example":1,
            "description":"This value is the primary id value obtained from Question Group table"
        },
        "templateId":{
            "type":"integer",
            "minimum":1,
            "maximum":9999,
            "example":1,
            "description":"This value is the primary id value obtained from Questionnaire Template table"
        },
        "group":{
            "type":"object",
            "properties":{
                "default":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":255,
                    "example":"Oracle Cruise Group"
                },
                "zh":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":255,
                    "example":"????????????????????????"
                }
            }
        }
    }
}

Nested Schema : group

Type: object

Show Source

• default(optional): string
  Minimum Length: 1

  Maximum Length: 255

  Example: Oracle Cruise Group
• zh(optional): string
  Minimum Length: 1

  Maximum Length: 255

  Example: ????????????????????????

{
    "type":"object",
    "properties":{
        "default":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "example":"Oracle Cruise Group"
        },
        "zh":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "example":"????????????????????????"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : QuestionGroup

Type: object

Questionnaire that is group together under a group

Show Source

• group(optional): object group
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 1

  This value is the primary id for Question Group

  Example: 1
• orderNumber(optional): integer
  Minimum Value: 1

  Maximum Value: 1

  This value is order number for Question Group

  Example: 1
• viewOnly(optional): boolean
  true = this Question Group cannot be modified

{
    "description":"Questionnaire that is group together under a group",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1,
            "maximum":1,
            "example":1,
            "description":"This value is the primary id for Question Group"
        },
        "group":{
            "type":"object",
            "properties":{
                "default":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":255,
                    "example":"Oracle Cruise Group"
                },
                "zh":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":255,
                    "example":"????????????????????????"
                }
            }
        },
        "orderNumber":{
            "type":"integer",
            "minimum":1,
            "maximum":1,
            "example":1,
            "description":"This value is order number for Question Group"
        },
        "viewOnly":{
            "type":"boolean",
            "description":"true = this Question Group cannot be modified"
        }
    }
}

Nested Schema : group

Type: object

Show Source

• default(optional): string
  Minimum Length: 1

  Maximum Length: 255

  Example: Oracle Cruise Group
• zh(optional): string
  Minimum Length: 1

  Maximum Length: 255

  Example: ????????????????????????

{
    "type":"object",
    "properties":{
        "default":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "example":"Oracle Cruise Group"
        },
        "zh":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "example":"????????????????????????"
        }
    }
}

204 Response

No Content

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionGroupErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Constraint Violation Exception:Invalid parameter"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Constraint Violation Exception:Invalid parameter"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionGroupErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionGroupErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Not Found",
        "detail":"Template not found."
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Not Found",
    "detail":"Template not found."
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionGroupErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Supported",
    "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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

415 Response

Unsupported Media Type

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionGroupErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"Content type Not supported"
    }
}

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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionGroupErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

Example:

{
    "type":"https://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

• detail(optional): string
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top