Get Revenue Center Groups
post
/config/sim/v2/setup/getRevenueCenterGroups
Gets Revenue Center Groups.
Request
Supported Media Types
- multipart/form-data
- application/json
The input body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name, revenueCenters -
includeAll:
string
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 -
langIds:
string
If specified, limits translated strings returned.Example:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order. Allowed fields are objectNum, hierUnitId, and name.Example:
objectNum:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Allowed fields are objectNum, hierUnitId, and name.Example:
where equals(hierUnitId, 3599)
Response
Supported Media Types
- application/json
200 Response
A collection of Revenue Center Groups.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
10 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Revenue Center Group objects.
-
limit:
integer
Server page size.Example:
10 -
offset:
integer
Starting resource record index.Example:
0 -
totalResults:
integer
Total number of rows.Example:
100
Nested Schema : items
Type:
arrayArray of Revenue Center Group objects.
Show Source
-
Array of:
object RevenueCenterGroup
Revenue Center Group record.
Nested Schema : RevenueCenterGroup
Type:
objectRevenue Center Group record.
Show Source
-
hierUnitId:
integer
Property hierarchy unit for the group.Example:
3599 -
name:
object name
Localized revenue center group name.
-
objectNum:
integer
User-facing group number.Example:
101 -
revenueCenters:
array revenueCenters
Revenue centers assigned to the group.
Nested Schema : name
Type:
objectLocalized revenue center group name.
Example:
{
"1":"Main Dining Group",
"2":"Groupe de salle principale",
"3":"Grupo de comedor principal"
}Nested Schema : items
Type:
Show Source
object-
rvcId:
integer
Revenue center identifier.Example:
10