Module: Genability::Client::LoadServingEntity

Included in:
Genability::Client
Defined in:
lib/genability/client/load_serving_entity.rb

Overview

Load Serving Entity (LSE) is the industry term for what most people would call a utility, or an electric company. Since there are different types of electric company, we use the term LSE in our API's. This is a company or other organization that supplies load (electrons, electricity) to a customer. In many cases this is the same company that distributes the electricity too, but in some cases customers can have one company that they buy the load from, and another that operates the distribution system (runs the line to the house, manages the meters etc). Some characteristics and uses:

  1. LSE's have territories that they operate in. Sometimes they operate in more than 1.
  2. LSE's have tariffs (rate plans) and are central to many of our data structures.

Instance Method Summary collapse

Instance Method Details

#load_serving_entities(options = {}) ⇒ Array Also known as: lses

Returns a list of load serving entities

Examples:

Return the first 25 load serving entities

Genability.load_serving_entities

Return the next 25 load serving entities

Genability.load_serving_entities(:page => 2)

Return only 10 load serving entities

Genability.load_serving_entities(:per_page => 10)

Search for load serving entities starting with the letters 'Ka'

Genability.load_serving_entities(:starts_with => 'Ka')

Search for load serving entities ending with the word 'Inc'

Genability.load_serving_entities(:ends_with => 'Inc')

Search for load serving entities with the word 'Energy'

Genability.load_serving_entities(:search_string => 'Energy')

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :search_string (String) —

    Phrase for searching the names of Load Serving Entities (Optional)

  • :starts_with (String) —

    Indicates the search phrase should match the start of the name. (Optional)

  • :ends_with (String) —

    Indicates the search phrase should match the end of the name. (Optional)

  • :page (Integer) —

    The page number to begin the result set from. If not specified, this will begin with the first result set. (Optional)

  • :per_page (Integer) —

    The number of results to return. If not specified, this will return 25 results. (Optional)

Returns:

  • (Array) —

    List of load serving entities.

See Also:

Rate Limited:

  • true

Supported formats:

  • :json

Requires Authentication:

  • true



39
40
41
 
# File 'lib/genability/client/load_serving_entity.rb', line 39

def load_serving_entities(options={})
  get("public/lses", lses_params(options)).results
end

#load_serving_entity(load_serving_entity_id) ⇒ Hashie::Mash Also known as: lse

Returns details for a single load serving entity

Examples:

Return the details for Georgia Power Co

Genability.load_serving_entity(2756)

Parameters:

  • load_serving_entity_id (Integer) —

    Unique Genability ID (primary key) for a Load Serving Entity.

Returns:

  • (Hashie::Mash) —

    Details for a load serving entity.

See Also:

Rate Limited:

  • true

Supported formats:

  • :json

Requires Authentication:

  • true



55
56
57
 
# File 'lib/genability/client/load_serving_entity.rb', line 55

def load_serving_entity(load_serving_entity_id)
  get("public/lses/#{load_serving_entity_id}").results.first
end