Jump to

• Request
• Response

Move or Copy Event Menu Tools to a Different Menu

put

/api/event/Menus/updateTools

Moves or copies event menu tools to a different menu. To move, specify a source menu in SourceMenuID. To copy, do not specify a source menu.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

  Example: 2
• SourceMenuID: integer
  The source event menu ID. To move event menu tools, specify an ID. To copy event menu tools, do not use this parameter.

  Example: 1
• Tools(required): array Tools
  The list of event menu tools.

{
    "type":"object",
    "required":[
        "id",
        "Tools"
    ],
    "properties":{
        "id":{
            "description":"The destination event menu ID.",
            "type":"integer",
            "example":"2",
            "required":true
        },
        "SourceMenuID":{
            "description":"The source event menu ID. To move event menu tools, specify an ID. To copy event menu tools, do not use this parameter.",
            "type":"integer",
            "example":"1"
        },
        "Tools":{
            "description":"The list of event menu tools.",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                1,
                2
            ],
            "required":true
        }
    }
}

Nested Schema : Tools

Type: array

The list of event menu tools.

Show Source

• Array of: integer

{
    "description":"The list of event menu tools.",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        1,
        2
    ],
    "required":true
}

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.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        }
    ]
}

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"
}

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