Skip to content

Energy carriers

Operations on energy carriers. Available on the client as client.energy_carriers.

energy_carriers.create

async def create(scenario_guid: str, request: EnergyCarrierRequestDtoV2) -> EnergyCarrierResponseDto

Create a new energy carrier in a scenario.

REST operation: POST /sympheny-app/v2/scenarios/{scenarioGuid}/carriers

Parameters

Name Type Required Description
scenario_guid str yes GUID of the scenario.
request EnergyCarrierRequestDtoV2 yes Request body.

Returns: EnergyCarrierResponseDto

async with AsyncSympheny(username, password) as client:
    carrier = await client.energy_carriers.create(scenario_guid, request)

with Sympheny(username, password) as client:
    carrier = client.energy_carriers.create(scenario_guid, request)

energy_carriers.list

async def list(scenario_guid: str) -> EnergyCarriersListResponseDto

List the energy carriers of a scenario.

REST operation: GET /sympheny-app/scenarios/{scenarioGuid}/carriers

Parameters

Name Type Required Description
scenario_guid str yes GUID of the scenario.

Returns: EnergyCarriersListResponseDto

async with AsyncSympheny(username, password) as client:
    carriers = await client.energy_carriers.list(scenario_guid)

with Sympheny(username, password) as client:
    carriers = client.energy_carriers.list(scenario_guid)

energy_carriers.get

async def get(carrier_guid: str) -> EnergyCarrierResponseDto

Get energy carrier details.

REST operation: GET /sympheny-app/carriers/{carrierGuid}

Parameters

Name Type Required Description
carrier_guid str yes GUID of the carrier.

Returns: EnergyCarrierResponseDto

async with AsyncSympheny(username, password) as client:
    carrier = await client.energy_carriers.get(carrier_guid)

with Sympheny(username, password) as client:
    carrier = client.energy_carriers.get(carrier_guid)

energy_carriers.update

async def update(carrier_guid: str, request: EnergyCarrierResponseDto) -> EnergyCarrierResponseDto

Update an energy carrier.

REST operation: PUT /sympheny-app/v2/carriers/{carrierGuid}

Parameters

Name Type Required Description
carrier_guid str yes GUID of the carrier.
request EnergyCarrierResponseDto yes Request body.

Returns: EnergyCarrierResponseDto

async with AsyncSympheny(username, password) as client:
    carrier = await client.energy_carriers.update(carrier_guid, request)

with Sympheny(username, password) as client:
    carrier = client.energy_carriers.update(carrier_guid, request)

energy_carriers.delete

async def delete(carrier_guid: str) -> EnergyCarriersListResponseDto

Delete an energy carrier; returns the remaining carriers.

REST operation: DELETE /sympheny-app/scenarios/carriers/{guid}

Parameters

Name Type Required Description
carrier_guid str yes GUID of the carrier.

Returns: EnergyCarriersListResponseDto

async with AsyncSympheny(username, password) as client:
    remaining = await client.energy_carriers.delete(carrier_guid)

with Sympheny(username, password) as client:
    remaining = client.energy_carriers.delete(carrier_guid)