Jump to

• Request
• Response

Update an Event Menu

put

/api/event/Menus/{id}

Updates the properties of the event menu that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The event menu ID.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DefaultMenu: integer
  Flag to indicate if this is the default menu or not.

  Example: 0
• MenuName: string
  The event menu name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  Example: Admin
• Tools: array Tools
  List of Tool IDs
• UserGroupID: integer
  The user group ID.

  Example: 1

{
    "type":"object",
    "properties":{
        "MenuName":{
            "$ref":"#/components/schemas/eventMenus/properties/MenuName"
        },
        "DefaultMenu":{
            "$ref":"#/components/schemas/eventMenusReadByID/properties/DefaultMenu"
        },
        "UserGroupID":{
            "$ref":"#/components/schemas/eventMenusReadByID/properties/UserGroupID"
        },
        "Tools":{
            "description":"List of Tool IDs",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                1,
                2
            ]
        }
    }
}

Nested Schema : Tools

Type: array

List of Tool IDs

Show Source

• Array of: integer

{
    "description":"List of Tool IDs",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        1,
        2
    ]
}

Example:

[
    1,
    2
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
  The response body for a successful update operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The list of updated event menus.",
                    "type":"array",
                    "items":{
                        "type":"integer"
                    },
                    "example":[
                        1,
                        2,
                        3,
                        4
                    ]
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful update operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The list of updated event menus.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The list of updated event menus.",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                1,
                2,
                3,
                4
            ]
        }
    }
}

Nested Schema : data

Type: array

The list of updated event menus.

Show Source

• Array of: integer

{
    "description":"The list of updated event menus.",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        1,
        2,
        3,
        4
    ]
}

Example:

[
    1,
    2,
    3,
    4
]

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top