Commission Site And Devices

Cloud Mock

https://mock.apidog.com/m1/479670-0-default

POST

/v1/commission

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

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "site": {
        "id": "abc-789",
        "first_name": "John",
        "last_name": "Doe",
        "company_name": "ABC Co.",
        "email": "[email protected]",
        "state_code": "AK",
        "city": "San Francisco",
        "zip_code": "88800",
        "street_address": "123 Main St",
        "street_address2": "string"
    },
    "devices": [
        {
            "id": "xyz-123",
            "site_id": "abc-789",
            "manufacturer_name": "DeviceMaker",
            "product_name": "Model 1",
            "serial_number": "123456789",
            "type": "BATTERY",
            "attributes": {
                "battery_capacity_wh": 15000,
                "battery_power_input_w": 6000,
                "battery_power_output_w": 7500
            },
            "install_date": "2025-06-19T15:30:00-07:00"
        }
    ],
    "can_auto_enroll": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mock.apidog.com/m1/479670-0-default/v1/commission' \
--header 'Content-Type: application/json' \
--data-raw '{
    "site": {
        "id": "abc-789",
        "first_name": "John",
        "last_name": "Doe",
        "company_name": "ABC Co.",
        "email": "[email protected]",
        "state_code": "AK",
        "city": "San Francisco",
        "zip_code": "88800",
        "street_address": "123 Main St",
        "street_address2": "string"
    },
    "devices": [
        {
            "id": "xyz-123",
            "site_id": "abc-789",
            "manufacturer_name": "DeviceMaker",
            "product_name": "Model 1",
            "serial_number": "123456789",
            "type": "BATTERY",
            "attributes": {
                "battery_capacity_wh": 15000,
                "battery_power_input_w": 6000,
                "battery_power_output_w": 7500
            },
            "install_date": "2025-06-19T15:30:00-07:00"
        }
    ],
    "can_auto_enroll": true
}'

Responses

🟢200OK

application/json

Body

Example

{
    "programs": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "Demo Program",
            "description": "This demo program is for demo purposes.",
            "eligible_device_types": [
                "BATTERY"
            ],
            "can_auto_enroll": true,
            "minimum_reserve_percentage": 20,
            "minimum_commitment_months": 12,
            "participation_months": [
                1
            ],
            "earnings_for_site_upfront": 1000,
            "earnings_for_site_yearly": 500,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "enrollment_form": [
                {
                    "name": "account_id",
                    "label": "Utility Account Number",
                    "type": "boolean",
                    "hint": "You can find it on your utility bill. [Learn more](https://example.com)"
                }
            ],
            "terms_and_conditions_version": "2025-01-01",
            "terms_and_conditions_text": "**Terms and conditions** You agree to these mock terms."
        }
    ],
    "enrollment": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "device_ids": [
            "xyz-123"
        ],
        "site_id": "abc-123",
        "program_id": "70c1146b-e933-4cb2-a789-bbca5312b517",
        "enroll_method": "AUTO_ENROLL",
        "status": "ACTIVE",
        "status_reason": "Enrollment approved by utility",
        "enrolled_at": "2019-08-24T14:15:22Z",
        "unenrolled_at": "2019-08-24T14:15:22Z",
        "program_specific_attributes": [
            {
                "name": "account_id",
                "value": "123456-0"
            }
        ],
        "has_agreed_to_terms_and_conditions": true,
        "terms_and_conditions_version": "2025-01-01"
    }
}

🟠400Invalid input

🟠409Conflict

Modified at 2024-05-21 17:43:09

Get Sites

Sessions