QualiCharge ♼ Carbure TIRUERT data exchange

[jmaupetit]

Purpose

As discussed lately with the CaburRe team, we need an exchange data format to automate TIRUERT volumes declaration from QualiCharge to Carbure.

Proposal

Here is a draft proposal expressed as a JSON schema:

{
  "type": "array",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "",
  "minItems": 1,
  "uniqueItems": true,
  "items": {
    "type": "object",
    "required": [
      "entity",
      "siren",
      "operational_units"
    ],
    "properties": {
      "entity": {
        "type": "string",
        "minLength": 1
      },
      "siren": {
        "type": "string",
        "minLength": 9,
        "maxLength": 9
      },
      "operational_units": {
        "type": "array",
        "uniqueItems": true,
        "minItems": 1,
        "items": {
          "required": [
            "code",
            "from",
            "to"
          ],
          "properties": {
            "code": {
              "type": "string",
              "minLength": 5,
              "maxLength": 5
            },
            "from": {
              "type": "string",
              "format": "date",
              "minLength": 8,
              "maxLength": 10
            },
            "to": {
              "type": "string",
              "format": "date",
              "minLength": 8,
              "maxLength": 10
            },
            "stations": {
              "type": "array",
              "uniqueItems": true,
              "minItems": 1,
              "items": {
                "required": [
                  "id",
                  "energy",
                  "is_controlled"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "FR[A-Z]{3}P.*",
                    "minLength": 7
                  },
                  "energy": {
                    "type": "number",
                    "minimum": 1
                  },
                  "is_controlled": {
                    "type": "boolean"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Example data may look like the following:

[
  {
    "entity": "Foo Inc.",
    "siren": "123456789",
    "operational_units": [
      {
        "code": "FRXXX",
        "from": "2025-01-01",
        "to": "2025-01-31",
        "stations": [
          {
            "id": "FRXXXP001",
            "energy": 123.4,
            "is_controlled": true
          },
          {
            "id": "FRXXXP002",
            "energy": 567.8,
            "is_controlled": false
          }
        ]
      },
      {
        "code": "FRYYY",
        "from": "2025-01-01",
        "to": "2025-01-31",
        "stations": [
          {
            "id": "FRYYYP001",
            "energy": 123.4,
            "is_controlled": true
          },
          {
            "id": "FRYYYP002",
            "energy": 567.8,
            "is_controlled": false
          }
        ]
      }
    ]
  },
  {
    "entity": "BAR Inc.",
    "siren": "987654321",
    "operational_units": [
      {
        "code": "FRZZZ",
        "from": "2025-01-01",
        "to": "2025-01-31",
        "stations": [
          {
            "id": "FRZZZP001",
            "energy": 123.4,
            "is_controlled": true
          },
          {
            "id": "FRZZZP002",
            "energy": 567.8,
            "is_controlled": false
          },
          {
            "id": "FRZZZP003",
            "energy": 901.2,
            "is_controlled": false
          }
        ]
      }
    ]
  }
]

[loco-philippe]

I agree with the JSON schema.

Concerning properties :

• is entity property equivalent to operator property ?
• how is_controlled property is calculated (not in Qualicharge schema)
• is it allowed to have stations that are not in Qualicharge (if yes, an additional boolean is required)

[jmaupetit]

* is `entity` property equivalent to `operator` property ?

This is a human-readable name representing a corporation that perceives the TIRUERT.

* how `is_controlled` property is calculated (not in Qualicharge schema)

is_controlled will be calculated on our side: it corresponds to a station connected to Enedis using a dedicated delivery point (DC).

* is it allowed to have `stations` that are not in Qualicharge (if yes, an additional boolean is required)

Nope, we will only send volumes for stations registered in our system.

[loco-philippe]

* is `entity` property equivalent to `operator` property ?

This is a human-readable name representing a corporation that perceives the TIRUERT.

Which field in Qualicharge Schema is associated to entity ( is it : Table group, field name ) ?

[jmaupetit]

Which field in Qualicharge Schema is associated to entity ( is it : Table group, field name ) ?

I think more of Amenageur.nom_amenageur.

[jfalxa]

Ok looking good! About the energy field, what unit is used? Also, will it be the raw energy delivered to the station, or just its renewable share? In any case, it would be useful to have both of those if you can get them.

[jmaupetit]

Ok looking good! About the energy field, what unit is used? Also, will it be the raw energy delivered to the station, or just its renewable share? In any case, it would be useful to have both of those if you can get them.

After internal discussions:

• The energy field unit will be MWh
• We would like to provide raw energy, thus, the renewable share and TIRUERT amounts would be calculated on your side.

WDYT?