Get Tariff Configurations Action | Energy and Utilities Cloud Developer Guide

This action is available in API version 68.0 and later.

Special Access Rules

The Get Tariff Configurations action is available in Enterprise and Unlimited Editions with Energy and Utilities Cloud.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/getTariffConfigurations
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
catalogCode	Type string Description Optional. The catalog code used to filter tariff configurations.
categoryCode	Type string Description Optional. The category code used to filter tariff configurations.
serviceType	Type string Description Optional. The service type used to filter tariff configurations.
includeAttributes	Type boolean Description Optional. Indicates whether to include tariff attributes in the response.

Outputs

Output	Details
commodityConfigResponse	Type Apex Description An Apex response that contains the commodity configuration details. Contains these fields. success (boolean) Indicates whether configuration retrieval succeeded. attributes (object[]) Tariff attributes used for comparison and configuration. Returned when `includeAttributes` is `true`. commodityCatalogList (object[]) Catalog and category structure used by tariff comparison. consumptionParamList (object[]) Consumption parameters supported for comparison. errors (object[]) List of errors returned for invalid or incomplete requests.

Output

Details

commodityConfigResponse

Type

Apex

Description

An Apex response that contains the commodity configuration details. Contains these fields.

success (boolean): Indicates whether configuration retrieval succeeded.
attributes (object[]): Tariff attributes used for comparison and configuration. Returned when includeAttributes is true.
commodityCatalogList (object[]): Catalog and category structure used by tariff comparison.
consumptionParamList (object[]): Consumption parameters supported for comparison.
errors (object[]): List of errors returned for invalid or incomplete requests.

Example

POST

This sample request is for the Get Tariff Configurations action.

1{
2  "inputs": [
3    {
4      "catalogCode": "ELEC_CATALOG",
5      "categoryCode": "RESIDENTIAL",
6      "serviceType": "Electricity",
7      "includeAttributes": true
8    }
9  ]
10}

This sample response is for the Get Tariff Configurations action.

1[
2  {
3    "actionName": "getTariffConfigurations",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outputValues": {
8      "commodityConfigResponse": {
9        "success": true,
10        "attributes": [],
11        "commodityCatalogList": [],
12        "consumptionParamList": [],
13        "errors": []
14      }
15    },
16    "sortOrder": -1,
17    "version": 1
18  }
19]