Library - Genability - TariffData - GetTariffs API

Get started with Arduino

Arduino

Library . Genability . TariffData . GetTariffs

Returns a list of Tariff objects based a specified search criteria.

Input

AppID The App ID provided by Genability.
AppKey The App Key provided by Genability.

Optional Input

AccountID The unique ID of the Account to find tariffs for. Values passed in will override those from the Account.
CustomerClasses Returns only these customer classes. Valid values are: RESIDENTIAL, GENERAL.
EffectiveOn Returns only tariffs that are effective on this date.
EndsWith When true, the search will only return results that end with the specified search string. Otherwise, any match of the search string will be returned as a result.
FromDateTime Returns only tariffs that are effective on or after this date.
IsRegex When true, the provided search string will be regarded as a regular expression and the search will return results matching the regular expression.
LSEID Filter tariffs for a specific LSE.
PageCount The number of results to return. Defaults to 25.
PageStart The page number to begin the result set from. Defaults to 1.
PopulateProperties Set to "true" to populate the properties for the returned Tariffs.
PopulateRates Set to "true" to populate the rate details for the returned Tariffs.
Search The string of text to search on. This can also be a regular expression, in which case you should set the 'isRegex' flag to true.
SearchOn Comma separated list of fields to query on. When searchOn is specified, the text provided in the search string field will be searched within these fields.
SortOn Comma separated list of fields to sort on.
SortOrder Comma separated list of ordering. Possible values are 'ASC' and 'DESC'. Default is 'ASC'. This list corresponds to the field list used in the SortOn input.
StartsWith When true, the search will only return results that begin with the specified search string. Otherwise, any match of the search string will be returned as a result.
TariffTypes Returns only these tariff types. Valid values are: DEFAULT, ALTERNATIVE, OPTIONAL_EXTRA, RIDER.
ToDateTime Returns only tariffs that are effective on or before this date.
ZipCode Return tariffs for a given zip or post code.

Output
Actuator Trigger Condition
If{"Response":{"type":"json","description":"The response from Genability."},"Success":{"type":"boolean"}}
Response
Response
Success
contains then write
High Low
to at 12
- Response The response from Genability.
CHOREO CLASS
- ```
/*
TembooTask class placeholder
*/
```
iOS HEADER
- ```
/*
TembooTask header placeholder
*/
```
- Simple
Device Configure Changed

Since you've changed your device configuration, you'll need to tell us about this new device.
1. Add a sensor or actuator to your device.
2. Register your board and download your code.
Get the Arduino SDK
OK! Let's set up your device

This feature is in experimental mode - pricing coming soon.

Device Name *

Device ID

Description

Location *

Use lat/long

Sensor Data
Frequency *

Pro Tip!

Power consumption will increase if you choose a higher frequency.

Safeguard data
what's this?

If connectivity is lost, up to 2MB of data will be stored locally on your device, and updated when connectivity is restored.

Commit your generated code
and collaborate with others.

Send your code straight to a GitHub repository.

Collaborating on GitHub?

Your code will be visible by others in your repos. Keep credentials private by saving a Profile or commit code with Placeholder inputs.

Choose a GitHub Repository

Name:

The following files will be added to this repo:

* Don't worry! Your credentials and any inputs that aren't saved in a Profile will not be included.

Success!

Visit the link below to view, modify, and share code.

Commit code to GitHub

Send code to CCS Cloud.

You'll be able to edit and share your code from TI's CCS Cloud IDE.

Name your application

Names can only contain letters, numbers, hyphens, and underscores.

The following will be sent to CCS Cloud:

TembooMain.c

TembooAccount.h

instructions.txt

+ 9 others

Success!

Visit the link below to view, modify, and share code.

https://dev.ti.com/ide/

Code
- ```
/*
Your auto-generated code will appear here once you've configured your device above.
*/
```

Header File

/* 
A header file containing your Temboo account information will appear here once you've
configured your device above.
*/

Notes

This Choreo returns a list of Tariff objects based a specified search criteria. The documentation for this Genability resource can be found here.

Below is an example of acceptable inputs:

AppID: {YOUR API ID}
AppKey: {YOUR APP KEY}
ZipCode: 11211

The following is a sample of the JSON information returned by this Choreo:

{
    "status": "success",
    "count": 24,
    "type": "Tariff",
    "results": [
        {
            "tariffId": 809,
            "masterTariffId": 809,
            "priorTariffId": 809,
            "lseId": 2252,
            "lseName": "Consolidated Edison Co-NY Inc",
            "tariffCode": "1",
            "tariffName": "Residential and Religious",
            "tariffType": "DEFAULT",
            "customerClass": "RESIDENTIAL",
            "customerCount": 2790056,
            "customerLikelihood": 29.31,
            "territoryId": 2533,
            "effectiveDate": "2010-03-31",
            "endDate": "2011-04-01",
            "chargeTypes": "FIXED_PRICE,CONSUMPTION_BASED",
            "chargePeriod": "DAILY",
            "hasTimeOfUseRates": false,
            "hasTieredRates": true,
            "hasRateApplicability": false,
            "timeZone": "US/Eastern",
            "isActive": false,
            "billingPeriod": "MONTHLY",
            "currency": "USD"
        },
        {
            "tariffId": 122720,
            "masterTariffId": 809,
            "priorTariffId": 122720,
            "lseId": 2252,
            "lseName": "Consolidated Edison Co-NY Inc",
            "tariffCode": "1",
            "tariffName": "Residential and Religious",
            "tariffType": "DEFAULT",
            "customerClass": "RESIDENTIAL",
            "customerCount": 2790056,
            "customerLikelihood": 29.31,
            "territoryId": 2533,
            "effectiveDate": "2011-04-01",
            "endDate": "2012-04-01",
            "chargeTypes": "FIXED_PRICE,CONSUMPTION_BASED",
            "chargePeriod": "DAILY",
            "hasTimeOfUseRates": false,
            "hasTieredRates": true,
            "hasRateApplicability": false,
            "timeZone": "US/Eastern",
            "isActive": false,
            "billingPeriod": "MONTHLY",
            "currency": "USD"
        },
        {
            "tariffId": 3153865,
            "masterTariffId": 809,
            "priorTariffId": 122720,
            "lseId": 2252,
            "lseName": "Consolidated Edison Co-NY Inc",
            "tariffCode": "1",
            "tariffName": "Residential and Religious",
            "tariffType": "DEFAULT",
            "customerClass": "RESIDENTIAL",
            "customerCount": 2790056,
            "customerLikelihood": 29.31,
            "territoryId": 2533,
            "effectiveDate": "2012-04-01",
            "endDate": null,
            "chargeTypes": "FIXED_PRICE,CONSUMPTION_BASED",
            "chargePeriod": "DAILY",
            "hasTimeOfUseRates": false,
            "hasTieredRates": true,
            "hasRateApplicability": false,
            "timeZone": "US/Eastern",
            "isActive": true,
            "billingPeriod": "MONTHLY",
            "currency": "USD"
        },
        {
            "tariffId": 57284,
            "masterTariffId": 57284,
            "priorTariffId": 57284,
            "lseId": 2252,
            "lseName": "Consolidated Edison Co-NY Inc",
            "tariffCode": "2",
            "tariffName": "General - Small",
            "tariffType": "ALTERNATIVE",
            "customerClass": "GENERAL",
            "customerCount": 364733,
            "customerLikelihood": 3.83,
            "territoryId": 2533,
            "effectiveDate": "2011-04-01",
            "endDate": "2012-04-01",
            "chargeTypes": "FIXED_PRICE,CONSUMPTION_BASED",
            "chargePeriod": "DAILY",
            "hasTimeOfUseRates": false,
            "hasTieredRates": true,
            "hasRateApplicability": false,
            "timeZone": "US/Eastern",
            "isActive": false,
            "billingPeriod": "MONTHLY",
            "currency": "USD"
        },
        {
            "tariffId": 3153868,
            "masterTariffId": 57284,
            "priorTariffId": 57284,
            "lseId": 2252,
            "lseName": "Consolidated Edison Co-NY Inc",
            "tariffCode": "2",
            "tariffName": "General - Small",
            "tariffType": "ALTERNATIVE",
            "customerClass": "GENERAL",
            "customerCount": 364733,
            "customerLikelihood": 3.83,
            "territoryId": 2533,
            "effectiveDate": "2012-04-01",
            "endDate": null,
            "chargeTypes": "FIXED_PRICE,CONSUMPTION_BASED",
            "chargePeriod": "DAILY",
            "hasTimeOfUseRates": false,
            "hasTieredRates": true,
            "hasRateApplicability": false,
            "timeZone": "US/Eastern",
            "isActive": true,
            "billingPeriod": "MONTHLY",
            "currency": "USD"
        }
    ]
}

Choreos

Choose your Edge Device

Pick a Choreo for your Gateway Device

Pick a Choreo for your Edge Device

Welcome back!

Forgot your password?

Choreos

Choose your Edge Device

Pick a Choreo for your Gateway Device

Pick a Choreo for your Edge Device

OK! Let's set up your device

Commit your generated code and collaborate with others.

Collaborating on GitHub?

Choose a GitHub Repository

Success!

Send code to CCS Cloud.

Name your application

Success!

Commit your generated code
and collaborate with others.