Get Event Types

post

/config/sim/v2/setup/getEventTypes

Gets Event Types and their nested Event Sub Type records.

Request

Supported Media Types
Body ()
The input body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • If specified, limits the data returned to these fields.
    Example: hierUnitId, objectNum, name, mainMenuLevelIndex, subMenuLevelIndex, subTypes
  • If this value is specified, the include parameter is ignored.
    Value Description
    basic Forces the response to include all fields except option string details
    detailed Forces the response to include all fields including option string details
    Example: detailed
  • If specified, limits translated strings returned.
    Example: 1,2,3
  • If using paging, number of results returned in this page.
    Example: 100
  • Starting resource record index.
    Example: 0
  • Sorts the response by the specified field name and sort order.
    Example: hierUnitId:asc
  • If specified, returns records that match the criteria.
    Example: where equals(hierUnitId, 3599)
Back to Top

Response

Supported Media Types

200 Response

A collection of Event Types.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of Event Type objects.
Show Source
Nested Schema : items
Type: object
Model for Event Type configuration.
Show Source
Nested Schema : name
Type: object
Event Type name in configured languages.
Example:
{
    "1":"Banquet",
    "2":"Banquete",
    "3":"Reception"
}
Nested Schema : subTypes
Type: array
Event Sub Type records associated with the Event Type.
Show Source
Nested Schema : items
Type: object
Model for an Event Sub Type associated with the Event Type.
Show Source
Nested Schema : name
Type: object
Event Sub Type name in configured languages.
Example:
{
    "1":"Wedding",
    "2":"Boda",
    "3":"Mariage"
}
Back to Top