Get Revenue Centers
post
/config/sim/v1/hierarchy/getRevenueCenters
Gets all the revenue centers for the specified organization
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : RVCBody
Type:
objectThe input Body model that needs to be given.
Show Source
-
include:
string
Objects included in response
-
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits translated strings returned
-
limit:
integer
If using paging, number of results returned in this page.
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported
-
orderBy:
string
Sorts the response by the specified field name and sort order.
-
searchCriteria:
string
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
A collection of RevenueCenter entities in an organization.
Root Schema : RevenueCenterGET
Type:
objectModel for RevenueCenter Object
Show Source
-
address1(required):
string
The address line 1 for the revenue center.Example:
Address Line 1 -
address2(required):
string
The address line 2 for the revenue center.Example:
Address Line 2 -
address3(required):
string
The address line 3 for the revenue center.Example:
Address Line 3 -
city(required):
string
The city for the revenue center.Example:
City -
consumerFacingName(required):
object consumerFacingName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the consumer facing name of the revenue center in the configured languages
-
country(required):
string
The country for the revenue center.Example:
United States -
countryCode(required):
string
The country code for the revenue center.Example:
US -
dataExtensions(required):
array dataExtensions
An array of extension data associated with the revenue center
-
floor(required):
string
The floor of the building.Example:
1st Floor -
hierStrucId(required):
integer
Unique reference of the hierarchy structure of the revenue center. Excluded by default.Example:
1 -
hierUnitId(required):
integer
Unique reference of the hierarchy unit of the revenue centerExample:
1 -
isLDSActive(required):
boolean
A flag indicating if LDS is activated for this revenue center.Example:
false -
kdsControllerId(required):
integer
The unique reference of the KDS Controller that controls the KDS Display Order Devices in this revenue center. Oracle recommends using no more than 15 KDS Display Order Devices on a single KDS ControllerExample:
2 -
kdsControllerName(required):
object kdsControllerName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the KDS controller in configured languages
-
latitude(required):
string
The revenue center latitude. Latitude must be within range -90 to +90Example:
12.23 -
locHierStrucId(required):
integer
Unique reference of the hierarchy structure of the property. Excluded by default.Example:
1 -
locHierUnitId(required):
integer
Unique reference of the hierarchy unit of the propertyExample:
1 -
locName(required):
object locName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the location configured languages
-
locObjNum(required):
integer
Object number of the propertyExample:
1 -
longitude(required):
string
The revenue center longitude. Longitude must be between -180 and 180Example:
12.34 -
name(required):
object name
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the revenue center configured languages
-
objectNum(required):
integer
Object number of the revenue centerExample:
1 -
phone(required):
string
The phone number of the revenue centerExample:
1234567890 -
phoneCountryCode(required):
string
The phone number country code of the revenue center.Example:
US -
phoneNumberPrefix(required):
integer
The phone number prefix of the revenue center.Example:
1 -
rvcGroups(required):
array rvcGroups
An object containing the descriptive options list associated with the revenue center groups associated with this revenue center
-
rvcId(required):
integer
This field shows the Revenue Center ID, an uneditable field that is the database ID number. This field is provided as a reference so that configuration can be completed for interfaces and other applications that require Revenue Center IDsExample:
1 -
rvcTypes(required):
string
A string value of 0s & 1s of length 32 representing the enablement or disablement of the revenue center types associated with the revenue center. If not specified, this will represent the default options associated with the revenue centerExample:
11111111111111111111111111111111 -
stateOrRegion(required):
string
The state or region for the revenue center.Example:
New York -
stateOrRegionCode(required):
string
The state or region code for the revenue center.Example:
NY -
zipOrPostalCode(required):
string
The ZIP or postal code for the revenue center.Example:
YXA123
Nested Schema : consumerFacingName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the consumer facing name of the revenue center in the configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : dataExtensions
Type:
arrayAn array of extension data associated with the revenue center
Show Source
Example:
{
"columnName":"extension column 1",
"value":"value 1"
}Nested Schema : kdsControllerName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the KDS controller in configured languages
Example:
{
"en-US":"Controller",
"de-DE":"Regler",
"es-MX":"Controlador"
}Nested Schema : locName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the location configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : name
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the revenue center configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : rvcGroups
Type:
arrayAn object containing the descriptive options list associated with the revenue center groups associated with this revenue center
Show Source
Example:
{
"rvcGroupNum":1
}Nested Schema : items
Type:
Show Source
object-
columnName:
string
The name of the extension data columnExample:
extension column 1 -
value:
string
The value associated with the extension data columnExample:
value 1
Nested Schema : items
Type:
Show Source
object-
rvcGroupNum:
integer
The object number of the revenue center group associated with the revenue centerExample:
1
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found