Jump to

• Request
• Response
• Examples

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

Body ()

The request body defines the details of the API request.

Root Schema : locRequestPayload

Type: object

Request payload with location reference

Show Source

• applicationName: string
  Title: Application Name

  Maximum Length: 128

  The name of the application which is accessing the API.

  First Available Version: 20.1.10

• include: string
  Title: Include

  List of objects to include in response
• locRef(required): string
  Title: Location Reference

  The location reference, this may be a store number or name depending on the organization
• searchCriteria: string
  Title: Search Criteria

  Search criteria to filter results based on field value

{
    "description":"Request payload with location reference",
    "properties":{
        "locRef":{
            "type":"string",
            "description":"The location reference, this may be a store number or name depending on the organization",
            "title":"Location Reference"
        },
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value",
            "title":"Search Criteria"
        },
        "include":{
            "type":"string",
            "description":"List of objects to include in response",
            "title":"Include"
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application which is accessing the API. <p>First Available Version: 20.1.10</p>",
            "title":"Application Name",
            "maxLength":"128"
        }
    },
    "required":[
        "locRef"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : revenueCenterDimensions

Type: object

The response body contains information about the revenue center dimensions for the specified locatio

Show Source

• locRef(required): string
  Title: Location Reference

  Maximum Length: 99

  The location reference, this may be a store number or name depending on the organization
• revenueCenters(required): array revenueCenters
  An array of revenue center dimensions

{
    "description":"The response body contains information about the revenue center dimensions for the specified locatio",
    "properties":{
        "locRef":{
            "type":"string",
            "title":"Location Reference",
            "description":"The location reference, this may be a store number or name depending on the organization",
            "maxLength":"99"
        },
        "revenueCenters":{
            "type":"array",
            "description":"An array of revenue center dimensions",
            "items":{
                "$ref":"#/definitions/revenueCenter"
            }
        }
    },
    "required":[
        "locRef",
        "revenueCenters"
    ]
}

Nested Schema : revenueCenters

Type: array

An array of revenue center dimensions

Show Source

• Array of: object revenueCenter
  The response body contains information about the revenue center for the specified location.

{
    "type":"array",
    "description":"An array of revenue center dimensions",
    "items":{
        "$ref":"#/definitions/revenueCenter"
    }
}

Nested Schema : revenueCenter

Type: object

The response body contains information about the revenue center for the specified location.

Show Source

• addrLn1: string
  Title: Address Line 1

  Maximum Length: 250 char

  Address 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 2

  Maximum Length: 250 char

  Address 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 3

  Maximum Length: 250 char

  Address 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 item

  Maximum Length: 40

  Category 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 item

  Maximum Length: 40

  Category 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 item

  Maximum Length: 40

  Category 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 item

  Maximum Length: 40

  Category 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 item

  Maximum Length: 20

  Category 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 item

  Maximum Length: 20

  Category 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 item

  Maximum Length: 20

  Category 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 item

  Maximum Length: 20

  Category 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 code

  Maximum Length: 2 char

  Two 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 name

  Maximum Length: 50 char

  Country 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 Name

  Maximum Length: 99

  The master Revenue Center name
• mstrNum: integer
  Title: Master Number

  Maximum Length: 16

  The master Revenue Center number
• name(required): string
  Title: Name

  Maximum Length: 99

  Revenue Center Name
• num(required): integer
  Title: Number

  Maximum Length: 16

  Revenue Center number
• phone: string
  Title: Telephone number

  Maximum Length: 20 char

  Telephone 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 code

  Maximum Length: 2 char

  Telephone 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 Postalcode

  Maximum Length: 20 char

  ZIP 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 code

  Maximum Length: 6 char

  Region 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 name

  Maximum Length: 40 char

  Region 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

{
    "description":"The response body contains information about the revenue center for the specified location.",
    "properties":{
        "num":{
            "type":"integer",
            "description":"Revenue Center number",
            "title":"Number",
            "maxLength":"16"
        },
        "name":{
            "type":"string",
            "description":"Revenue Center Name",
            "title":"Name",
            "maxLength":"99"
        },
        "mstrNum":{
            "type":"integer",
            "description":"The master Revenue Center number",
            "title":"Master Number",
            "maxLength":"16"
        },
        "mstrName":{
            "type":"string",
            "description":"The master Revenue Center name",
            "title":"Master Name",
            "maxLength":"99"
        },
        "catGrpHierName1":{
            "type":"string",
            "description":"Category Group Hierarchy #1 assigned to the master item. This attribute will not be returned in the response if value is null. <p>First Available Version 20.1.14.13</p>",
            "title":"Category Group Hierarchy #1 assigned to the master item",
            "maxLength":"40"
        },
        "catGrpName1":{
            "type":"string",
            "description":"Category Group #1 assigned to the master item. This attribute will not be returned in the response if value is null. <p>First Available Version 20.1.14.13</p>",
            "title":"Category Group #1 assigned to the master item",
            "maxLength":"20"
        },
        "catGrpHierName2":{
            "type":"string",
            "description":"Category Group Hierarchy #2 assigned to the master item. This attribute will not be returned in the response if value is null. <p>First Available Version 20.1.14.13</p>",
            "title":"Category Group Hierarchy #2 assigned to the master item",
            "maxLength":"40"
        },
        "catGrpName2":{
            "type":"string",
            "description":"Category Group #2 assigned to the master item. This attribute will not be returned in the response if value is null. <p>First Available Version 20.1.14.13</p>",
            "title":"Category Group #2 assigned to the master item",
            "maxLength":"20"
        },
        "catGrpHierName3":{
            "type":"string",
            "description":"Category Group Hierarchy #3 assigned to the master item. This attribute will not be returned in the response if value is null. <p>First Available Version 20.1.14.13</p>",
            "title":"Category Group Hierarchy #3 assigned to the master item",
            "maxLength":"40"
        },
        "catGrpName3":{
            "type":"string",
            "description":"Category Group #3 assigned to the master item. This attribute will not be returned in the response if value is null. <p>First Available Version 20.1.14.13</p>",
            "title":"Category Group #3 assigned to the master item",
            "maxLength":"20"
        },
        "catGrpHierName4":{
            "type":"string",
            "description":"Category Group Hierarchy #4 assigned to the master item. This attribute will not be returned in the response if value is null. <p>First Available Version 20.1.14.13</p>",
            "title":"Category Group Hierarchy #4 assigned to the master item",
            "maxLength":"40"
        },
        "catGrpName4":{
            "type":"string",
            "description":"Category Group #4 assigned to the master item. This attribute will not be returned in the response if value is null. <p>First Available Version 20.1.14.13</p>",
            "title":"Category Group #4 assigned to the master item",
            "maxLength":"20"
        },
        "addrLn1":{
            "type":"string",
            "description":"Address Line 1. This attribute is optional and will not be returned in the response by default.<p>First available version 20.1.16</p>",
            "title":"Address Line 1",
            "maxLength":"250 char"
        },
        "addrLn2":{
            "type":"string",
            "description":"Address Line 2. This attribute is optional and will not be returned in the response by default.<p>First available version 20.1.16</p>",
            "title":"Address Line 2",
            "maxLength":"250 char"
        },
        "addrLn3":{
            "type":"string",
            "description":"Address Line 3. This attribute is optional and will not be returned in the response by default.<p>First available version 20.1.16</p>",
            "title":"Address Line 3",
            "maxLength":"250 char"
        },
        "postalCode":{
            "type":"string",
            "description":"ZIP or Postalcode. This attribute is optional and will not be returned in the response by default.<p>First available version 20.1.16</p>",
            "title":"ZIP or Postalcode",
            "maxLength":"20 char"
        },
        "phone":{
            "type":"string",
            "description":"Telephone number. This attribute is optional and will not be returned in the response by default.<p>First available version 20.1.16</p>",
            "title":"Telephone number",
            "maxLength":"20 char"
        },
        "phoneCountryCode":{
            "type":"string",
            "description":"Telephone country code. This attribute is optional and will not be returned in the response by default.<p>First available version 20.1.16</p>",
            "title":"Telephone country code",
            "maxLength":"2 char"
        },
        "countryCode":{
            "type":"string",
            "description":"Two character country code as defined in ISO 3166-2 standard. This attribute is optional and will not be returned in the response by default.<p>First available version 20.1.16</p>",
            "title":"Two character country code",
            "maxLength":"2 char"
        },
        "countryName":{
            "type":"string",
            "description":"Country name as defined in ISO 3166-2 standard. This attribute is optional and will not be returned in the response by default.<p>First available version 20.1.16</p>",
            "title":"Country name",
            "maxLength":"50 char"
        },
        "regionCode":{
            "type":"string",
            "description":"Region code as defined in ISO 3166-2 standard for subdivisions. This attribute is optional and will not be returned in the response by default.<p>First available version 20.1.16</p>",
            "title":"Region code",
            "maxLength":"6 char"
        },
        "regionName":{
            "type":"string",
            "description":"Region name as defined in ISO 3166-2 standard for subdivisions. This attribute is optional and will not be returned in the response by default.<p>First available version 20.1.16</p>",
            "title":"Region name",
            "maxLength":"40 char"
        }
    },
    "required":[
        "num",
        "name",
        "catGrpHierName1",
        "catGrpName1",
        "catGrpHierName2",
        "catGrpName2",
        "catGrpHierName3",
        "catGrpName3",
        "catGrpHierName4",
        "catGrpName4"
    ]
}

400 Response

Bad Request

Body ()

Root Schema : exceptionDetailType

Type: object

Exception details

Show Source

• detail: string
  Title: Error Description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle Error Code

  Oracle error code
• status: integer
  Title: Status

  HTTP Response Code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Exception details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle Error Code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error Description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP Response Code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

401 Response

Unauthorized

Body ()

Root Schema : exceptionDetailType

Type: object

Exception details

Show Source

• detail: string
  Title: Error Description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle Error Code

  Oracle error code
• status: integer
  Title: Status

  HTTP Response Code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Exception details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle Error Code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error Description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP Response Code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

403 Response

Service Unavailable

Body ()

Root Schema : exceptionDetailType

Type: object

Exception details

Show Source

• detail: string
  Title: Error Description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle Error Code

  Oracle error code
• status: integer
  Title: Status

  HTTP Response Code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Exception details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle Error Code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error Description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP Response Code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

404 Response

Resource Not Found

Body ()

Root Schema : exceptionDetailType

Type: object

Exception details

Show Source

• detail: string
  Title: Error Description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle Error Code

  Oracle error code
• status: integer
  Title: Status

  HTTP Response Code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Exception details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle Error Code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error Description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP Response Code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

Default Response

Unexpected Error

Body ()

Root Schema : exceptionDetailType

Type: object

Exception details

Show Source

• detail: string
  Title: Error Description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle Error Code

  Oracle error code
• status: integer
  Title: Status

  HTTP Response Code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Exception details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle Error Code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error Description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP Response Code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

Back to Top

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"
  }]
}

Back to Top