Jump to

• Request
• Response

Create an Event Menu

post

/api/event/Menus

Creates a new event menu.
The minimum required properties in the request body are:

• MenuName
• UserGroupID
• DefaultMenu
• ParentMenuID
• Tools

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

• 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
• ParentMenuID: integer
  Parent Menu ID

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

  Example: 1

{
    "type":"object",
    "properties":{
        "MenuName":{
            "description":"The event menu name.\n<br>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, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Admin"
        },
        "ParentMenuID":{
            "$ref":"#/components/schemas/eventMenusReadByID/properties/ParentMenuID"
        },
        "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 SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new event menu.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventMenusReadByID"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

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

  Example: true

{
    "description":"The response body for a successful add 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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the new event menu.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new event menu.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventMenusReadByID"
            }
        },
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        }
    }
}

Nested Schema : data

Type: array

The properties of the new event menu.

Show Source

• Array of: object eventMenusReadByID

{
    "description":"The properties of the new event menu.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventMenusReadByID"
    }
}

Nested Schema : eventMenusReadByID

Type: object

Show Source

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

  Example: 0
• MenuID: integer
  The event menu ID.

  Example: 2
• MenuName: string
  Menu Name

  Example: Administrators
• ParentMenuID: integer
  Parent Menu ID

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

  Example: 1

{
    "type":"object",
    "properties":{
        "MenuName":{
            "description":"Menu Name",
            "type":"string",
            "example":"Administrators"
        },
        "MenuID":{
            "description":"The event menu ID.",
            "type":"integer",
            "example":"2"
        },
        "UserGroupID":{
            "description":"The user group ID.",
            "type":"integer",
            "example":"1"
        },
        "DefaultMenu":{
            "description":"Flag to indicate if this is the default menu or not.",
            "type":"integer",
            "example":"0"
        },
        "ParentMenuID":{
            "description":"Parent Menu ID",
            "type":"integer",
            "example":"1"
        },
        "Tools":{
            "description":"List of Tool IDs",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "ToolID":{
                        "description":"Tool ID",
                        "type":"integer",
                        "example":"1"
                    },
                    "ToolName":{
                        "description":"Tool Name",
                        "type":"string",
                        "example":"Acknowledge"
                    }
                }
            },
            "example":[
                {
                    "ToolID":"1",
                    "ToolName":"Acknowledge"
                },
                {
                    "ToolID":"2",
                    "ToolName":"UnAcknowledge"
                }
            ]
        }
    }
}

Nested Schema : Tools

Type: array

List of Tool IDs

Show Source

• Array of: object items

{
    "description":"List of Tool IDs",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "ToolID":{
                "description":"Tool ID",
                "type":"integer",
                "example":"1"
            },
            "ToolName":{
                "description":"Tool Name",
                "type":"string",
                "example":"Acknowledge"
            }
        }
    },
    "example":[
        {
            "ToolID":"1",
            "ToolName":"Acknowledge"
        },
        {
            "ToolID":"2",
            "ToolName":"UnAcknowledge"
        }
    ]
}

Example:

[
    {
        "ToolID":"1",
        "ToolName":"Acknowledge"
    },
    {
        "ToolID":"2",
        "ToolName":"UnAcknowledge"
    }
]

Nested Schema : items

Type: object

Show Source

• ToolID: integer
  Tool ID

  Example: 1
• ToolName: string
  Tool Name

  Example: Acknowledge

{
    "type":"object",
    "properties":{
        "ToolID":{
            "description":"Tool ID",
            "type":"integer",
            "example":"1"
        },
        "ToolName":{
            "description":"Tool Name",
            "type":"string",
            "example":"Acknowledge"
        }
    }
}

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