Get Revenue Center Groups

post

/config/sim/v2/setup/getRevenueCenterGroups

Gets Revenue Center Groups.

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, revenueCenters
  • 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: objectNum: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 Revenue Center Groups.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of Revenue Center Group objects.
Show Source
Nested Schema : RevenueCenterGroup
Type: object
Revenue Center Group record.
Show Source
Nested Schema : name
Type: object
Localized revenue center group name.
Example:
{
    "1":"Main Dining Group",
    "2":"Groupe de salle principale",
    "3":"Grupo de comedor principal"
}
Nested Schema : revenueCenters
Type: array
Revenue centers assigned to the group.
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top