Flip Energy API

Commission Site And Devices

POST/v1/commission

Note that you need the client authentication token (not the site token) to access the API.

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

site

object (Site)

required

string

required

The ID of the site in your system.

first_name

string | null

optional

last_name

string | null

optional

string <email> | null

optional

state_code

string | null

State

optional

>= 2 characters<= 2 characters

city

string | null

City

optional

zip_code

string | null

Zip Code

optional

In the sandbox, use zip codes 88800, 88801 or 88802 to match with test programs.

Examples:

888008880188802

street_address

string | null

Street Address

optional

street_address2

string | null

Street Address2

optional

service_account_id

string | null

Service Account Id

optional

An ID assigned to the residential customer by the utility. Can typically be found on the utility bill.

devices

array [object {8}]

required

string

required

The ID of the device in your system.

manufacturer_name

string

Manufacturer Name

required

product_name

string

Product Name

required

serial_number

string

Serial Number

required

type

enum<string>

required

Allowed values:

BATTERYEV_CHARGER

attributes

object (DeviceBatteryAttributes)

required

Structure depends on type. They are not user-adjustable and should be configured during installation / commissioning.

configuration

object (DeviceBatteryConfig)

required

Structure depends on type

install_date

string <date-time> | null

optional

The date the device was installed at the customer's site, or the date it received permission to operate from the utility, if different.

can_auto_enroll

boolean

Is Opt Out

required

{
  "site": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "[email protected]",
    "state_code": "st",
    "city": "string",
    "zip_code": "88800",
    "street_address": "string",
    "street_address2": "string",
    "service_account_id": "string"
  },
  "devices": [
    {
      "id": "string",
      "manufacturer_name": "string",
      "product_name": "string",
      "serial_number": "string",
      "type": "BATTERY",
      "attributes": {
        "battery_capacity_wh": 0,
        "battery_power_input_w": 0,
        "battery_power_output_w": 0
      },
      "configuration": {
        "reserve_percentage": 0
      },
      "install_date": "2019-08-24T14:15:22.123Z"
    }
  ],
  "can_auto_enroll": true
}

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

programs

array[object (Program) {14}]

Programs

required

string <uuid>

required

name

string

Name

required

description

string

required

eligible_device_types

array[string]

Eligible Device Types

required

Allowed values:

BATTERYEV_CHARGER

can_auto_enroll

boolean

required

minimum_commitment_months

integer | null

required

Can be null if the minimum commitment is currently not known.

participation_months

array[integer]

required

List of calendar months (range 1-12) in which the program is active

earnings_for_site_upfront

integer

required

Estimated one-time upfront earnings in the program, based on the site information

earnings_for_site_yearly

integer

required

Estimated yearly recurring earnings in the program, based on the site information

created_at

string <date-time>

Created At

required

updated_at

string <date-time>

Updated At

required

enrollment_form

array [object {3}]

required

A program might require special information from the end user on enrollment. If it does, this array will contain each of them. They should be used to dynamically convert into form fields.

terms_and_conditions_version

string | null

required

If a program requires terms and conditions to be agreed with, the current version will be provided here. It should not be displayed to the user.

terms_and_conditions_text

string | null

required

If a program requires terms and conditions to be agreed with, the full text of the current version, in Markdown format, will be provided here. It should be displayed to the user.

enrollment

object (Enrollment)

read-onlyoptional

string <uuid>

required

device_ids

array[string]

required

site_id

string

required

program_id

string <uuid>

Program Id

required

enroll_method

enum<string>

required

Allowed values:

AUTO_ENROLLUSER_ACTION

status

enum<string>

required

Allowed values:

ACTIVENEEDS_ACTIONPENDINGREJECTEDUNENROLLED

status_reason

string | null

read-onlyrequired

enrolled_at

string <date-time> | null

Enrolled At

read-onlyrequired

unenrolled_at

string <date-time> | null

Unenrolled At

read-onlyrequired

program_specific_attributes

array [object {2}]

required

has_agreed_to_terms_and_conditions

boolean | null

required

terms_and_conditions_version

string | null

required

{
  "programs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "eligible_device_types": [
        "BATTERY"
      ],
      "can_auto_enroll": true,
      "minimum_commitment_months": 0,
      "participation_months": [
        0
      ],
      "earnings_for_site_upfront": 0,
      "earnings_for_site_yearly": 0,
      "created_at": "2019-08-24T14:15:22.123Z",
      "updated_at": "2019-08-24T14:15:22.123Z",
      "enrollment_form": [
        {
          "name": "string",
          "label": "string",
          "type": "boolean"
        }
      ],
      "terms_and_conditions_version": "string",
      "terms_and_conditions_text": "string"
    }
  ],
  "enrollment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "device_ids": [
      "string"
    ],
    "site_id": "string",
    "program_id": "70c1146b-e933-4cb2-a789-bbca5312b517",
    "enroll_method": "AUTO_ENROLL",
    "status": "ACTIVE",
    "status_reason": "string",
    "enrolled_at": "2019-08-24T14:15:22.123Z",
    "unenrolled_at": "2019-08-24T14:15:22.123Z",
    "program_specific_attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "has_agreed_to_terms_and_conditions": true,
    "terms_and_conditions_version": "string"
  }
}

Last modified: 8 months ago