Account

get

Authorizations

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

get

HTTPcURLJavaScriptPython

GET /api/account HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "result": {
    "id": "text",
    "domain": "text",
    "stationCountLimit": 1,
    "electricalPricePerKwh": 1,
    "electricalCo2PerKwh": 1,
    "currency": "text",
    "enableLostProductionCost": true,
    "dashboardConfig": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "redshiftPassword": "text",
    "uploadTransforms": "text",
    "defaultAutoEndOnQuantityComplete": true,
    "createdAt": "text",
    "updatedAt": "text",
    "cursors": [
      {
        "type": "text",
        "timestamp": 1,
        "value": "text",
        "valueAgo": "text"
      }
    ],
    "redshiftConfig": {
      "host": "text",
      "port": 1,
      "username": "text"
    }
  }
}

post

Authorizations

Body

enableLostProductionCostbooleanOptionalDefault: false

currencystring · enum | nullableOptionalPossible values:

electricalPricePerKwhnumber | nullableOptional

electricalCo2PerKwhnumber | nullableOptional

dashboardConfigstring | nullableOptional

resetRedshiftPasswordbooleanOptional

uploadTransformsstringOptional

defaultAutoEndOnQuantityCompletebooleanOptionalDefault: false

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

post

HTTPcURLJavaScriptPython

POST /api/account HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "enableLostProductionCost": false,
  "currency": "GBP",
  "electricalPricePerKwh": 1,
  "electricalCo2PerKwh": 1,
  "dashboardConfig": "text",
  "resetRedshiftPassword": true,
  "uploadTransforms": "text",
  "defaultAutoEndOnQuantityComplete": false
}

{
  "isSuccess": true,
  "result": {
    "id": "text",
    "domain": "text",
    "stationCountLimit": 1,
    "electricalPricePerKwh": 1,
    "electricalCo2PerKwh": 1,
    "currency": "text",
    "enableLostProductionCost": true,
    "dashboardConfig": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "redshiftPassword": "text",
    "uploadTransforms": "text",
    "defaultAutoEndOnQuantityComplete": true,
    "createdAt": "text",
    "updatedAt": "text"
  }
}