SubscriptionWrite

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/engrate/main/json-schema/engrate-subscription-write-schema.json",
  "title": "SubscriptionWrite",
  "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/SubscriptionWrite",
  "type": "object",
  "required": [
    "callbackUrl",
    "eventTypes"
  ],
  "properties": {
    "callbackUrl": {
      "type": "string",
      "format": "uri",
      "description": "Endpunkt des Abonnenten, an den Ereignisse zugestellt werden."
    },
    "eventTypes": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "string",
        "enum": [
          "locationBundleChanged",
          "clearingCaseOpened",
          "clearingCaseResolved",
          "subscriptionRevoked"
        ]
      }
    },
    "filter": {
      "type": "object",
      "description": "Optionale Einschränkung auf bestimmte Lokationen.",
      "properties": {
        "marketLocations": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/MaloId"
          }
        },
        "networkLocations": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/NeloId"
          }
        }
      }
    }
  },
  "$defs": {
    "MaloId": {
      "type": "string",
      "pattern": "^\\d{11}$",
      "description": "Identifiziert die Marktlokation oder Tranche."
    },
    "NeloId": {
      "type": "string",
      "pattern": "^E[A-Z\\d]{9}\\d$",
      "description": "Netzlokations-ID."
    }
  }
}