Get Event Areas

post

/config/sim/v2/setup/getEventAreas

Gets Event Areas

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
  • 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. Allowed fields are objectNum, hierUnitId, and name.
    Example: hierUnitId:asc
  • If specified, returns records that match the criteria. Allowed fields are objectNum, hierUnitId, and name.
    Example: where equals(hierUnitId, 3599)
Back to Top

Response

Supported Media Types

200 Response

A collection of Event Areas.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of Event Area objects.
Show Source
Nested Schema : EventArea
Type: object
Event Area record
Show Source
Nested Schema : name
Type: object
A group of string objects representing the name of the Event Area in configured languages.
Example:
{
    "1":"Patio",
    "2":"Terrasse",
    "3":"Patio"
}
Back to Top