Get revenue centers
post
/bi/v1/{orgIdentifier}/getRevenueCenterDimensions
Gets the revenue centers configured for the specified location.
Request
Path Parameters
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : locRequestPayload
Type:
objectRequest payload with location reference
Show Source
-
applicationName:
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
include:
string
Title:
IncludeList of objects to include in response -
locRef(required):
string
Title:
Location ReferenceThe location reference, this may be a store number or name depending on the organization -
searchCriteria:
string
Title:
Search CriteriaSearch criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : revenueCenterDimensions
Type:
objectThe response body contains information about the revenue center dimensions for the specified locatio
Show Source
-
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
revenueCenters(required):
array revenueCenters
An array of revenue center dimensions
Nested Schema : revenueCenters
Type:
arrayAn array of revenue center dimensions
Show Source
-
Array of:
object revenueCenter
The response body contains information about the revenue center for the specified location.
Nested Schema : revenueCenter
Type:
objectThe response body contains information about the revenue center for the specified location.
Show Source
-
addrLn1:
string
Title:
Address Line 1Maximum Length:250Address Line 1. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
-
addrLn2:
string
Title:
Address Line 2Maximum Length:250Address Line 2. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
-
addrLn3:
string
Title:
Address Line 3Maximum Length:250Address Line 3. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
-
catGrpHierName1(required):
string
Title:
Category Group Hierarchy #1 assigned to the master itemMaximum Length:40Category Group Hierarchy #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpHierName2(required):
string
Title:
Category Group Hierarchy #2 assigned to the master itemMaximum Length:40Category Group Hierarchy #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpHierName3(required):
string
Title:
Category Group Hierarchy #3 assigned to the master itemMaximum Length:40Category Group Hierarchy #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpHierName4(required):
string
Title:
Category Group Hierarchy #4 assigned to the master itemMaximum Length:40Category Group Hierarchy #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpName1(required):
string
Title:
Category Group #1 assigned to the master itemMaximum Length:20Category Group #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpName2(required):
string
Title:
Category Group #2 assigned to the master itemMaximum Length:20Category Group #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpName3(required):
string
Title:
Category Group #3 assigned to the master itemMaximum Length:20Category Group #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpName4(required):
string
Title:
Category Group #4 assigned to the master itemMaximum Length:20Category Group #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
countryCode:
string
Title:
Two character country codeMaximum Length:2Two character country code as defined in ISO 3166-2 standard. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
-
countryName:
string
Title:
Country nameMaximum Length:50Country name as defined in ISO 3166-2 standard. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
-
mstrName:
string
Title:
Master NameMaximum Length:99The master Revenue Center name -
mstrNum:
integer
Title:
Master NumberMaximum Length:16The master Revenue Center number -
name(required):
string
Title:
NameMaximum Length:99Revenue Center Name -
num(required):
integer
Title:
NumberMaximum Length:16Revenue Center number -
phone:
string
Title:
Telephone numberMaximum Length:20Telephone number. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
-
phoneCountryCode:
string
Title:
Telephone country codeMaximum Length:2Telephone country code. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
-
postalCode:
string
Title:
ZIP or PostalcodeMaximum Length:20ZIP or Postalcode. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
-
regionCode:
string
Title:
Region codeMaximum Length:6Region code as defined in ISO 3166-2 standard for subdivisions. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
-
regionName:
string
Title:
Region nameMaximum Length:40Region name as defined in ISO 3166-2 standard for subdivisions. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Examples
The following example shows how to get the revenue center dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H "Authorization: Bearer" -H "Content-Type:application/json" -d {"locRef":"1234"} https://baseurl/bi/v1/orgidentifier/getRevenueCenterDimensions
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Tue, 20 Oct 2020 21:24:33 GMT Transfer-Encoding: chunked Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"locRef": "1234",
"revenueCenters":[{
"num":152,
"name": "Bar",
"mstrNumNum":152,
"mstrNameName": "Bar",
"addrLn1": "7031 Columbia Gateway Dr",
"addrLn2": "Floor 3",
"addrLn3": "Columbia, MD 21046",
"postalCode": "21046",
"phone": "4432856000",
"phoneCountryCode": "1",
"countryCode": "US",
"countryName": "United States",
"regionCode": "MD",
"regionName": "Maryland",
"catGrpHierName1": "Category Hierarchy 1",
"catGrpName1": "Category Group 1",
"catGrpHierName2": "Category Hierarchy 2",
"catGrpName2": "Category Group 2",
"catGrpHierName3": "Category Hierarchy 3",
"catGrpName3": "Category Group 3",
"catGrpHierName4": "Category Hierarchy 4",
"catGrpName4": "Category Group 4"
}]
}