{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/elhub/json-schema/elhub-party-membership-history-response-schema.json",
  "title": "party_membership_history_response",
  "description": "Party Membership - history",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/elhub-party-membership-api-openapi.yml#/components/schemas/party_membership_history_response",
  "summary": "Party Membership - history",
  "properties": {
    "id": {
      "description": "Unique surrogate identifier.",
      "format": "bigint",
      "type": "integer",
      "readOnly": true
    },
    "party_id": {
      "description": "Reference to the party that the membership links to an entity.",
      "format": "bigint",
      "type": "integer"
    },
    "entity_id": {
      "description": "Reference to the entity that the party represents.",
      "format": "bigint",
      "type": "integer"
    },
    "scopes": {
      "description": "List of scopes granted to the entity when it acts as the party. Scopes are inspired from OAuth 2.0 and allow refinement of access control and privilege delegation mechanisms.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/auth_scope"
      },
      "nullable": false
    },
    "recorded_at": {
      "description": "When the resource was recorded (created or updated) in the system.",
      "format": "date-time",
      "type": "string",
      "readOnly": true
    },
    "recorded_by": {
      "description": "The identity that recorded the resource.",
      "format": "bigint",
      "type": "integer",
      "readOnly": true
    },
    "party_membership_id": {
      "description": "Reference to the resource that was updated.",
      "format": "bigint",
      "type": "integer"
    },
    "replaced_by": {
      "description": "The identity that updated the resource when it was replaced.",
      "format": "bigint",
      "type": [
        "integer",
        "null"
      ]
    },
    "replaced_at": {
      "description": "When the resource was replaced in the system.",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    },
    "party_history": {
      "description": "Embedded party_history",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/party_history_response"
          }
        },
        {
          "type": "null"
        }
      ],
      "nullable": true
    }
  },
  "required": [
    "id",
    "party_id",
    "entity_id",
    "scopes",
    "recorded_at",
    "recorded_by",
    "party_membership_id"
  ],
  "$defs": {
    "auth_scope": {
      "description": "Authorization scopes.",
      "format": "text",
      "type": "string",
      "enum": [
        "manage:attachment",
        "manage:attachment:service_providing_group_product_application_attachment",
        "manage:auth",
        "manage:data",
        "manage:data:accounting_point_grid_location",
        "manage:data:controllable_unit",
        "manage:data:controllable_unit_service_provider",
        "manage:data:controllable_unit_suspension",
        "manage:data:controllable_unit_suspension_comment",
        "manage:data:entity",
        "manage:data:entity_client",
        "manage:data:notification",
        "manage:data:party",
        "manage:data:party_membership",
        "manage:data:service_provider_product_application",
        "manage:data:service_provider_product_application_comment",
        "manage:data:service_provider_product_suspension",
        "manage:data:service_provider_product_suspension_comment",
        "manage:data:service_providing_group",
        "manage:data:service_providing_group_grid_prequalification",
        "manage:data:service_providing_group_grid_prequalification_comment",
        "manage:data:service_providing_group_grid_suspension",
        "manage:data:service_providing_group_grid_suspension_comment",
        "manage:data:service_providing_group_membership",
        "manage:data:service_providing_group_product_application",
        "manage:data:service_providing_group_product_application_comment",
        "manage:data:service_providing_group_product_suspension",
        "manage:data:service_providing_group_product_suspension_comment",
        "manage:data:system_operator_product_type",
        "manage:data:technical_resource",
        "read:attachment",
        "read:attachment:service_providing_group_product_application_attachment",
        "read:attachment:service_providing_group_product_application_attachment_history",
        "read:auth",
        "read:data",
        "read:data:accounting_point",
        "read:data:accounting_point_balance_responsible_party",
        "read:data:accounting_point_bidding_zone",
        "read:data:accounting_point_end_user",
        "read:data:accounting_point_energy_supplier",
        "read:data:accounting_point_grid_location",
        "read:data:accounting_point_grid_location_history",
        "read:data:accounting_point_metering_grid_area",
        "read:data:controllable_unit",
        "read:data:controllable_unit_history",
        "read:data:controllable_unit_service_provider",
        "read:data:controllable_unit_service_provider_history",
        "read:data:controllable_unit_summary",
        "read:data:controllable_unit_suspension",
        "read:data:controllable_unit_suspension_comment",
        "read:data:controllable_unit_suspension_comment_history",
        "read:data:controllable_unit_suspension_history",
        "read:data:entity",
        "read:data:entity_client",
        "read:data:event",
        "read:data:identity",
        "read:data:metering_grid_area",
        "read:data:notice",
        "read:data:notification",
        "read:data:party",
        "read:data:party_history",
        "read:data:party_membership",
        "read:data:party_membership_history",
        "read:data:product_type",
        "read:data:service_provider_product_application",
        "read:data:service_provider_product_application_comment",
        "read:data:service_provider_product_application_comment_history",
        "read:data:service_provider_product_application_history",
        "read:data:service_provider_product_suspension",
        "read:data:service_provider_product_suspension_comment",
        "read:data:service_provider_product_suspension_comment_history",
        "read:data:service_provider_product_suspension_history",
        "read:data:service_providing_group",
        "read:data:service_providing_group_grid_prequalification",
        "read:data:service_providing_group_grid_prequalification_comment",
        "read:data:service_providing_group_grid_prequalification_comment_history",
        "read:data:service_providing_group_grid_prequalification_history",
        "read:data:service_providing_group_grid_suspension",
        "read:data:service_providing_group_grid_suspension_comment",
        "read:data:service_providing_group_grid_suspension_comment_history",
        "read:data:service_providing_group_grid_suspension_history",
        "read:data:service_providing_group_history",
        "read:data:service_providing_group_membership",
        "read:data:service_providing_group_membership_history",
        "read:data:service_providing_group_power_per_substation",
        "read:data:service_providing_group_product_application",
        "read:data:service_providing_group_product_application_comment",
        "read:data:service_providing_group_product_application_comment_history",
        "read:data:service_providing_group_product_application_history",
        "read:data:service_providing_group_product_suspension",
        "read:data:service_providing_group_product_suspension_comment",
        "read:data:service_providing_group_product_suspension_comment_history",
        "read:data:service_providing_group_product_suspension_history",
        "read:data:service_providing_group_summary",
        "read:data:system_operator_product_type",
        "read:data:system_operator_product_type_history",
        "read:data:technical_resource",
        "read:data:technical_resource_history",
        "read:grid",
        "read:grid:line",
        "read:grid:substation",
        "read:grid:substation_cluster",
        "use:auth",
        "use:data",
        "use:data:controllable_unit",
        "use:data:controllable_unit:lookup",
        "use:data:entity",
        "use:data:entity:lookup"
      ]
    },
    "party_business_id_type": {
      "description": "The type of the business identifier.",
      "format": "text",
      "type": "string",
      "default": "uuid",
      "enum": [
        "gln",
        "uuid",
        "eic_x",
        "org"
      ]
    },
    "party_history_response": {
      "summary": "Party - history",
      "description": "Party - history",
      "properties": {
        "id": {
          "description": "Unique surrogate identifier.",
          "format": "bigint",
          "type": "integer",
          "readOnly": true
        },
        "business_id": {
          "description": "The business identifier of the party. Format depends on `business_id_type`.",
          "format": "text",
          "type": "string"
        },
        "business_id_type": {
          "$ref": "#/$defs/party_business_id_type",
          "default": "uuid"
        },
        "entity_id": {
          "description": "Reference to the entity that is the parent of the party.",
          "format": "bigint",
          "type": "integer"
        },
        "name": {
          "description": "Name of the party. Maximum 128 characters.",
          "format": "text",
          "type": "string"
        },
        "role": {
          "$ref": "#/$defs/party_role"
        },
        "type": {
          "$ref": "#/$defs/party_type"
        },
        "status": {
          "$ref": "#/$defs/party_status",
          "default": "new"
        },
        "recorded_at": {
          "description": "When the resource was recorded (created or updated) in the system.",
          "format": "date-time",
          "type": "string",
          "readOnly": true
        },
        "recorded_by": {
          "description": "The identity that recorded the resource.",
          "format": "bigint",
          "type": "integer",
          "readOnly": true
        },
        "party_id": {
          "description": "Reference to the resource that was updated.",
          "format": "bigint",
          "type": "integer"
        },
        "replaced_by": {
          "description": "The identity that updated the resource when it was replaced.",
          "format": "bigint",
          "type": [
            "integer",
            "null"
          ]
        },
        "replaced_at": {
          "description": "When the resource was replaced in the system.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "business_id",
        "business_id_type",
        "entity_id",
        "name",
        "role",
        "type",
        "status",
        "recorded_at",
        "recorded_by",
        "party_id"
      ]
    },
    "party_role": {
      "description": "The role of the party. Currently maps to 1:1 to `type`. E.g. system_operator, service_provider.",
      "format": "text",
      "type": "string",
      "enum": [
        "flex_balance_responsible_party",
        "flex_end_user",
        "flex_energy_supplier",
        "flex_flexibility_information_system_operator",
        "flex_market_operator",
        "flex_organisation",
        "flex_service_provider",
        "flex_system_operator",
        "flex_third_party"
      ]
    },
    "party_status": {
      "description": "The status of the party.",
      "format": "text",
      "type": "string",
      "default": "new",
      "enum": [
        "new",
        "active",
        "inactive",
        "suspended",
        "terminated"
      ]
    },
    "party_type": {
      "description": "The type of the party, e.g SystemOperator, ServiceProvider",
      "format": "text",
      "type": "string",
      "enum": [
        "balance_responsible_party",
        "end_user",
        "energy_supplier",
        "flexibility_information_system_operator",
        "market_operator",
        "organisation",
        "service_provider",
        "system_operator",
        "third_party"
      ]
    }
  }
}