MeteringLocationDocument

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/engrate/main/json-schema/engrate-metering-location-document-schema.json",
  "title": "MeteringLocationDocument",
  "x-generated": "2026-10-15",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/engrate-netzbetreiber-api-openapi.yml#/components/schemas/MeteringLocationDocument",
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "meloId",
        "metering"
      ],
      "properties": {
        "type": {
          "const": "Messlokation"
        },
        "meloId": {
          "$ref": "#/$defs/MeloId"
        },
        "href": {
          "type": "string",
          "format": "uri-reference"
        },
        "meteringPointOperator": {
          "$ref": "#/$defs/MarketPartnerRef"
        },
        "metering": {
          "$ref": "#/$defs/Metering"
        }
      }
    },
    "links": {
      "type": "object",
      "properties": {
        "self": {
          "$ref": "#/$defs/Link"
        },
        "locationBundles": {
          "$ref": "#/$defs/Link"
        }
      }
    }
  },
  "$defs": {
    "FlatRateMetering": {
      "type": "object",
      "required": [
        "type"
      ],
      "additionalProperties": false,
      "properties": {
        "type": {
          "const": "pauschal"
        },
        "description": {
          "type": "string",
          "description": "Pauschale Messlokation ohne Zähler. Trägt eine Zählpunktbezeichnung, aber\nkeine Messeinrichtung, keine OBIS-Kennzahlen und keine Messwerte.\n\nMitteilung Nr. 57 sieht vor, dass künftig jede Marktlokation Strom mindestens\neine zugeordnete Messlokation aufweist — entweder eine pauschale ohne Zähler\noder eine gemessene. Dieser Typ macht die Unterscheidung im Schema explizit,\nstatt sie einer Bedingung im Anwendungshandbuch zu überlassen.\n"
        }
      }
    },
    "IntelligentMeteringSystem": {
      "type": "object",
      "required": [
        "type",
        "configurationId",
        "obisCodes"
      ],
      "additionalProperties": false,
      "properties": {
        "type": {
          "const": "iMS"
        },
        "configurationId": {
          "type": "string",
          "description": "Konfigurations-ID. Bei einem intelligenten Messsystem erforderlich."
        },
        "obisCodes": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "string"
          }
        }
      }
    },
    "Link": {
      "type": "object",
      "required": [
        "href"
      ],
      "properties": {
        "href": {
          "type": "string",
          "format": "uri-reference",
          "description": "URL der referenzierten Ressource."
        },
        "title": {
          "type": "string"
        }
      }
    },
    "MarketPartnerId": {
      "type": "string",
      "pattern": "^\\d{13}$",
      "description": "Marktpartner-ID."
    },
    "MarketPartnerRef": {
      "type": "object",
      "required": [
        "marketPartnerId"
      ],
      "properties": {
        "marketPartnerId": {
          "$ref": "#/$defs/MarketPartnerId"
        },
        "role": {
          "type": "string",
          "enum": [
            "NB",
            "LF",
            "MSB",
            "MWV",
            "UENB"
          ]
        },
        "href": {
          "type": "string",
          "format": "uri-reference"
        }
      }
    },
    "MeloId": {
      "type": "string",
      "pattern": "^DE\\d{11}[A-Z\\d]{20}$",
      "description": "Messlokations-ID (Zählpunktbezeichnung)."
    },
    "Metering": {
      "description": "Die Messung an einer Messlokation, als tagged union über die Art des Messsystems.\n\n**Konkretes Beispiel für den Nutzen:** Bei einem intelligenten Messsystem ist die\nKonfigurations-ID erforderlich; bei einem konventionellen Messsystem darf sie\nnicht vorhanden sein; bei einer pauschalen Messlokation gibt es weder Zähler noch\nOBIS-Kennzahlen noch Messwerte. Heute stehen diese drei Regeln als Bedingungen im\nAnwendungshandbuch. Hier sind sie Teil des Schemas: Ein Payload, der einer\npauschalen Messlokation eine OBIS-Kennzahl zuordnet, ist schlicht nicht gültig und\nwird von jedem Standardvalidator abgelehnt — nicht erst im Produktivbetrieb durch\neinen Klärfall.\n",
      "oneOf": [
        {
          "$ref": "#/$defs/IntelligentMeteringSystem"
        },
        {
          "$ref": "#/$defs/ModernMeteringDevice"
        },
        {
          "$ref": "#/$defs/FlatRateMetering"
        }
      ]
    },
    "ModernMeteringDevice": {
      "type": "object",
      "required": [
        "type",
        "obisCodes"
      ],
      "additionalProperties": false,
      "properties": {
        "type": {
          "const": "mME"
        },
        "obisCodes": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}