Batteries

List batteries

curl https://app.rejoule.io/batteries/ \
    -H "Authorization: User <token>"

The following query parameters are available:

Name	Type	Description
`limit`	integer	Number of results to return per page.
`offset`	integer	The initial index from which to return the results.
`id`	string	id
`organization`	string	organization
`battery_id`	string	battery_id
`battery_type`	string	battery_type
`vin`	string	vin
`vehicle_model`	string	vehicle_model
`vehicle_make`	string	vehicle_make
`vehicle_year`	string	vehicle_year
`second_life_battery_id`	string	second_life_battery_id
`original_serial_number`	string	original_serial_number
`predicted_soh`	string	predicted_soh
`predicted_soh_confidence`	string	predicted_soh_confidence
`measured_soh`	string	measured_soh
`dcir`	string	dcir
`project`	string	project
`created`	string	created
`updated`	string	updated

Create a battery

Member Role required

Editing requires an Member role in the organization the resource belongs to. Find out more.

curl https://app.rejoule.io/batteries/ \
    -X POST \
    -H "Authorization: User <token>" \
    -F "organization=11" \
    -F "battery_id=hello-world" \
    -F "battery_type=17"

List battery types

curl https://app.rejoule.io/batteries/types/ \
    -H "Authorization: User <token>"

The following query parameters are available:

Name	Type	Description
`limit`	integer	Number of results to return per page.
`offset`	integer	The initial index from which to return the results.
`id`	string	id
`organization`	string	organization
`model`	string	model
`chemistry`	string	chemistry
`default_vehicle_model`	string	default_vehicle_model
`default_vehicle_make`	string	default_vehicle_make
`default_vehicle_year`	string	default_vehicle_year
`vehicle_charging_protocol`	string	vehicle_charging_protocol
`classification`	string	classification
`created`	string	created
`updated`	string	updated

Create a battery type

Member Role required

Editing requires an Member role in the organization the resource belongs to. Find out more.

curl https://app.rejoule.io/batteries/types/ \
    -X POST \
    -H "Authorization: User <token>" \
    -F "organization=4" \
    -F "model=hello-world" \
    -F "classification=pack"

Get a single battery type

curl https://app.rejoule.io/batteries/types/{id}/ \
    -H "Authorization: User <token>"

The response object contains the following fields:

Name	Type	Description
`id`	integer
`organization`	integer
`model`	string
`classification`	string
`chemistry`	string	The chemistry of the battery
`default_vehicle_model`	string
`default_vehicle_make`	string
`default_vehicle_year`	integer
`vehicle_charging_protocol`	string
`nominal_voltage`	number
`maximum_voltage`	number
`minimum_voltage`	number
`nominal_capacity`	number
`nominal_energy`	number
`default_battery_model`	integer	The default battery model to be used to make estiamtes for all batteries of this type. The latest version will be used. If a default model version is selected, it takes precedence over this value.
`default_battery_model_version`	integer	The default battery model version to be used to make estimates for all batteries of this type.
`notes`	string
`created_at`	string
`updated_at`	string

Update a battery type

Member Role required

Editing requires an Member role in the organization the resource belongs to. Find out more.

curl https://app.rejoule.io/batteries/types/{id}/ \
    -X PUT \
    -H "Authorization: User <token>" \
    -F "organization=9" \
    -F "model=hello-world" \
    -F "classification=vehicle"

Delete a battery type

Owner Role required

Deleting requires an Owner role in the organization the resource belongs to. Find out more.

curl https://app.rejoule.io/batteries/types/{id}/ \
    -X DELETE \
    -H "Authorization: User <token>"

Get a single battery

curl https://app.rejoule.io/batteries/{id}/ \
    -H "Authorization: User <token>"

The response object contains the following fields:

Name	Type	Description
`id`	integer
`organization`	integer
`battery_id`	string
`vin`	string
`vehicle_model`	string
`vehicle_make`	string
`vehicle_year`	integer
`second_life_battery_id`	string
`battery_type`	integer
`battery_type_details`	object
`projects`	array
`original_serial_number`	string
`predicted_soh`	number
`predicted_soh_confidence`	number
`measured_soh`	number
`dcir`	number
`notes`	string
`created_at`	string
`updated_at`	string

Update a battery

Member Role required

Editing requires an Member role in the organization the resource belongs to. Find out more.

curl https://app.rejoule.io/batteries/{id}/ \
    -X PUT \
    -H "Authorization: User <token>" \
    -F "organization=20" \
    -F "battery_id=hello-world" \
    -F "battery_type=16"

Delete a battery

Owner Role required

Deleting requires an Owner role in the organization the resource belongs to. Find out more.

curl https://app.rejoule.io/batteries/{id}/ \
    -X DELETE \
    -H "Authorization: User <token>"