Get an Event Menu by ID
get
/api/event/Menus/{id}
Gets the event menu that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The event menu ID.Example:
1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
Nested Schema : SuccessfulGetOperation
Type:
object
The response body for a successful get operation.
Show Source
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : eventMenusReadByID
Type:
Show Source
object
-
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 NameExample:
Administrators
-
ParentMenuID: integer
Parent Menu IDExample:
1
-
Tools: array
Tools
List of Tool IDs
-
UserGroupID: integer
The user group ID.Example:
1
Nested Schema : Tools
Type:
array
List of Tool IDs
Show Source
Example:
[
{
"ToolID":"1",
"ToolName":"Acknowledge"
},
{
"ToolID":"2",
"ToolName":"UnAcknowledge"
}
]
Nested Schema : items
Type:
Show Source
object
-
ToolID: integer
Tool IDExample:
1
-
ToolName: string
Tool NameExample:
Acknowledge
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
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.
Nested Schema : items
Type:
object
An error.