Record the previous platform's baseline of chargers

put/v1/migrations/{migration_id}/parity/baseline

Requires an API key

What the previous platform has for each charger, from its export: configuration keys and values, the tariff (currency and prices in minor units) and the sessions it recorded in a window (count and energy in Wh). Parity reports compare it with Ivora's records. A section given replaces that section of the charger's baseline; the others stay. Secret configuration keys (passwords, keys, tokens) and the keys that decide where the charger connects (CentralSystemURL and similar) are dropped and never stored. Prices are minor units, decimals for a sub-cent price. 64 KiB per call (about 25 chargers with a full OCPP 1.6 configuration; tariff-only baselines up to 500); a configuration has at most 300 keys, each value at most 500 characters. Needs migration:import (client, support, partner; a key needs stations:write). A participant narrowed to some sites covers and reads the chargers at its sites only. Audited (migration.parity.baseline_recorded) in the same transaction; nothing is recorded unless its entry is stored. Errors: 404 migration_charger_not_in_migration, 404 migration_not_found, 409 migration_closed, 413 request_too_large, 503 migration_audit_unavailable. See Errors and statuses.

Path parameters

migration_idstringRequired
Pattern ^mig_[0-9a-f]{32}$

Request body

chargersarray of BaselineChargerRequired
Each charger's baseline; a section given replaces that section of its earlier baseline, the sections left out stay. The body is at most 64 KiB: about 25 chargers with a full OCPP 1.6 configuration, up to 500 with a tariff only.
Child attributes
- station_idintegerRequired
  A charger of the migration.
  Greater than 0
- configurationobject | null
  The charger's configuration on the previous platform: key to value (at most 300 keys, values at most 500 characters), keys named as Ivora's configuration read names them (OCPP 1.6 keys such as MeterValueSampleInterval; OCPP 2.x component/variable labels). Secret keys (passwords, keys, tokens) and the keys that decide where the charger connects (CentralSystemURL and similar) are dropped, never stored.
- tariffobject | null
  The price the previous platform charges on it.
  Child attributes
  - currencystringRequired
    ISO 4217, upper case.
    Pattern ^[A-Z]{3}$
  - rate_minor_per_kwhinteger | number | null
    Energy price, minor units per kWh; null or 0: none. Decimal minor units for a sub-cent price (35.5: USD 0.355), at most 4 decimals.
  - rate_minor_per_minuteinteger | number | null
    Time price, minor units per minute; null or 0: none. Decimal minor units for a sub-cent price (35.5: USD 0.355), at most 4 decimals.
  - session_fee_minorinteger | number | null
    Flat fee per session, minor units; null or 0: none. Decimal minor units for a sub-cent price (35.5: USD 0.355), at most 4 decimals.
- sessionsobject | null
  The sessions the previous platform recorded on it in a window.
  Child attributes
  - sincestringRequired
    The window's start (ISO 8601 with offset), inclusive: sessions that started at or after it.
    Up to 40 characters
  - untilstringRequired
    The window's end (ISO 8601 with offset), exclusive. At most 31 days after since.
    Up to 40 characters
  - countintegerRequired
    Sessions the previous platform recorded on the charger that started in the window.
    Minimum 0 · Maximum 1000000
  - energy_whintegerRequired
    Their energy, Wh, summed.
    Minimum 0 · Maximum 1000000000000

Returns · 200

recordedintegerRequired
chargersarray of BaselineRecordedRequired
Child attributes
- station_idintegerRequired
- charger_keystringRequired
- sectionsarray of enumRequired
  The sections this call recorded.
- dropped_keysarray of stringRequired
  Configuration keys left out, never stored: secrets, and the keys that decide where the charger connects (never compared; a URL can carry credentials).

Errors

401 Unauthorized 403 Forbidden 404 Not found 409 Conflict 422 Invalid request 429 Rate limited 502 Upstream error 503 Unavailable

PUT /v1/migrations/{migration_id}/parity/baseline

curl --fail-with-body -X PUT "https://api.ivoracharge.com/v1/migrations/mig_0123456789abcdef0123456789abcdef/parity/baseline" \
  -H "Authorization: Bearer $IVORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "chargers": [
    {
      "station_id": 1
    }
  ]
}'

Response · 200JSON

{
  "recorded": 1,
  "chargers": [
    {
      "station_id": 1,
      "charger_key": "string",
      "sections": [
        "configuration"
      ],
      "dropped_keys": [
        "string"
      ]
    }
  ]
}

Requires an approved production API keyProduction access starts with a request, a short meeting with Ivora and a card on file, after which Ivora staff grant your account access. How to request access

Try itproduction · api.ivoracharge.com

Production API key iv_live_…

Paste a production api key (iv_live_…). Create keys in Developer tools. The key stays in this page's memory, is sent only to https://api.ivoracharge.com and clears when you reload. Test keys are refused.

migration_idpath · required

Request body application/json

PUT is a write: you confirm the method, path and project before it is sent, with a generated Idempotency-Key.