Skip to main content

PaginatedResponse[GetProfileDTO]

data object[]required
  • Array [
    • profile_idProfile Id (string)required
    site_idSite Id (string)required
    description object
    anyOf
    string
    ac object
    anyOf
    default_estimated_departure_time_deltaDefault Estimated Departure Time Delta (string)required

    The time a vehicle is expected to charge expressed in ISO 8601 time delta, this will be used if we receive an AC transaction with this profile_id, without an estimated departure time.

    default_requested_min_energyDefault Requested Min Energy (integer)required

    The default requested minimum energy (Wh) for AC transactions with this profile, this will be used if we receive a transaction with this profile_id, without a requested minimum energy.

    default_requested_max_energyDefault Requested Max Energy (integer)required

    The default requested maximum energy (Wh) for AC transactions with this profile, this will be used if we receive a transaction with this profile_id, without a requested maximum energy.

    default_minimal_charging_current object

    The minimal charging current (in Amperes) for AC transactions with this profile. When set, this site-level minimum is applied to every AC transaction with this profile, overriding the per-transaction value. Used to compute minimum power constraints.

    anyOf
    number
    default_allow_zero_current object

    Whether AC transactions with this profile allow zero current charging periods. When set, this site-level value is applied to every AC transaction with this profile, overriding the per-transaction value. A vehicle that physically cannot pause charging still forces zero current to be disallowed regardless of this setting.

    anyOf
    boolean
    dc object
    anyOf
    default_estimated_departure_time_deltaDefault Estimated Departure Time Delta (string)required

    The time a vehicle is expected to charge expressed in ISO 8601 time delta, this will be used if we receive a DC transaction with this profile_id, without an estimated departure time.

    default_requested_min_state_of_chargeDefault Requested Min State Of Charge (number)required

    The default requested minimum state of charge (in percentage) for DC transactions with this profile, this will be used if we receive a transaction with this profile_id, without a requested minimum state of charge.

    Possible values: >= 0 and <= 100

    default_requested_max_state_of_chargeDefault Requested Max State Of Charge (number)required

    The default requested maximum state of charge (in percentage) for DC transactions with this profile, this will be used if we receive a transaction with this profile_id, without a requested maximum state of charge.

    Possible values: >= 0 and <= 100

    override_transaction_inputOverride Transaction Input (boolean)
    Default value: false
    apply_to object
    driver_idsstring[]

    The identifiers of the drivers this profile applies to.

    charger_asset_idsstring[]

    The asset identifiers of the chargers (AC or DC) this profile applies to.

  • ]
    • page_sizePage Size (integer)required
    end_cursor object

    Cursor to retrieve the next page of results.

    anyOf
    string

    Possible values: non-empty

    has_next_pageHas Next Page (boolean)
    Default value: false
    PaginatedResponse[GetProfileDTO]
    {
      "data": [
        {
          "profile_id": "profile-ev-fleet",
          "site_id": "site-1",
          "description": "string",
          "ac": {
            "default_estimated_departure_time_delta": "PT8H",
            "default_requested_min_energy": 20000,
            "default_requested_max_energy": 30000,
            "default_minimal_charging_current": 6,
            "default_allow_zero_current": false
          },
          "dc": {
            "default_estimated_departure_time_delta": "PT8H",
            "default_requested_min_state_of_charge": 80,
            "default_requested_max_state_of_charge": 100
          },
          "override_transaction_input": false,
          "apply_to": {
            "driver_ids": [
              "driver-1"
            ],
            "charger_asset_ids": [
              "LR34_001"
            ]
          }
        }
      ],
      "page_size": 0,
      "end_cursor": "string",
      "has_next_page": false
    }