Elhub · Schema

service_provider_product_suspension_history_response

Service Provider Product Suspension - history

CompanyEnergyElectricityData HubMeteringOpen DataNorwayUtilities

Properties

Name Type Description
id integer Unique surrogate identifier.
procuring_system_operator_id integer Reference to the procuring system operator suspending the service provider.
service_provider_id integer Reference to the service provider being suspended.
product_type_ids array References to the suspended product types.
reason object
recorded_at string When the resource was recorded (created or updated) in the system.
recorded_by integer The identity that recorded the resource.
service_provider_product_suspension_id integer Reference to the resource that was updated.
replaced_by integernull The identity that updated the resource when it was replaced.
replaced_at stringnull When the resource was replaced in the system.
procuring_system_operator_history object Embedded party_history
service_provider_history object Embedded party_history
comment_history object Embedded service_provider_product_suspension_comment_history
View JSON Schema on GitHub

JSON Schema

elhub-service-provider-product-suspension-history-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/elhub/json-schema/elhub-service-provider-product-suspension-history-response-schema.json",
  "title": "service_provider_product_suspension_history_response",
  "description": "Service Provider Product Suspension - history",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/elhub-service-provider-product-suspension-api-openapi.yml#/components/schemas/service_provider_product_suspension_history_response",
  "summary": "Service Provider Product Suspension - history",
  "properties": {
    "id": {
      "description": "Unique surrogate identifier.",
      "format": "bigint",
      "type": "integer",
      "readOnly": true
    },
    "procuring_system_operator_id": {
      "description": "Reference to the procuring system operator suspending the service provider.",
      "format": "bigint",
      "type": "integer"
    },
    "service_provider_id": {
      "description": "Reference to the service provider being suspended.",
      "format": "bigint",
      "type": "integer"
    },
    "product_type_ids": {
      "description": "References to the suspended product types.",
      "type": "array",
      "items": {
        "format": "bigint",
        "type": "integer"
      }
    },
    "reason": {
      "$ref": "#/$defs/service_provider_product_suspension_reason"
    },
    "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
    },
    "service_provider_product_suspension_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"
      ]
    },
    "procuring_system_operator_history": {
      "description": "Embedded party_history",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/party_history_response"
          }
        },
        {
          "type": "null"
        }
      ],
      "nullable": true
    },
    "service_provider_history": {
      "description": "Embedded party_history",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/party_history_response"
          }
        },
        {
          "type": "null"
        }
      ],
      "nullable": true
    },
    "comment_history": {
      "description": "Embedded service_provider_product_suspension_comment_history",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/service_provider_product_suspension_comment_history_response"
          }
        },
        {
          "type": "null"
        }
      ],
      "nullable": true
    }
  },
  "required": [
    "id",
    "procuring_system_operator_id",
    "service_provider_id",
    "product_type_ids",
    "reason",
    "recorded_at",
    "recorded_by",
    "service_provider_product_suspension_id"
  ],
  "$defs": {
    "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"
      ]
    },
    "service_provider_product_suspension_comment_history_response": {
      "summary": "Service Provider Product Suspension Comment - history",
      "description": "Service Provider Product Suspension Comment - history",
      "properties": {
        "id": {
          "description": "Unique surrogate identifier.",
          "format": "bigint",
          "type": "integer",
          "readOnly": true
        },
        "service_provider_product_suspension_id": {
          "description": "Reference to the service provider product suspension.",
          "format": "bigint",
          "type": "integer"
        },
        "created_by": {
          "description": "Reference to the identity that created the comment.",
          "format": "bigint",
          "type": "integer",
          "readOnly": true
        },
        "created_at": {
          "description": "When the comment was added to the SPPS.",
          "format": "date-time",
          "type": "string",
          "readOnly": true
        },
        "visibility": {
          "$ref": "#/$defs/service_provider_product_suspension_comment_visibility",
          "default": "same_party"
        },
        "content": {
          "description": "Free text content of the comment.",
          "format": "text",
          "type": "string",
          "maxLength": 2048
        },
        "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
        },
        "service_provider_product_suspension_comment_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"
          ]
        },
        "service_provider_product_suspension_history": {
          "description": "Embedded service_provider_product_suspension_history",
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/$defs/service_provider_product_suspension_history_response"
              }
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        }
      },
      "required": [
        "id",
        "service_provider_product_suspension_id",
        "created_by",
        "created_at",
        "visibility",
        "content",
        "recorded_at",
        "recorded_by",
        "service_provider_product_suspension_comment_id"
      ]
    },
    "service_provider_product_suspension_comment_visibility": {
      "description": "The level of visibility of the comment.",
      "format": "text",
      "type": "string",
      "default": "same_party",
      "enum": [
        "same_party",
        "any_involved_party"
      ]
    },
    "service_provider_product_suspension_history_response": {
      "summary": "Service Provider Product Suspension - history",
      "description": "Service Provider Product Suspension - history",
      "properties": {
        "id": {
          "description": "Unique surrogate identifier.",
          "format": "bigint",
          "type": "integer",
          "readOnly": true
        },
        "procuring_system_operator_id": {
          "description": "Reference to the procuring system operator suspending the service provider.",
          "format": "bigint",
          "type": "integer"
        },
        "service_provider_id": {
          "description": "Reference to the service provider being suspended.",
          "format": "bigint",
          "type": "integer"
        },
        "product_type_ids": {
          "description": "References to the suspended product types.",
          "type": "array",
          "items": {
            "format": "bigint",
            "type": "integer"
          }
        },
        "reason": {
          "$ref": "#/$defs/service_provider_product_suspension_reason"
        },
        "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
        },
        "service_provider_product_suspension_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"
          ]
        },
        "procuring_system_operator_history": {
          "description": "Embedded party_history",
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/$defs/party_history_response"
              }
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        },
        "service_provider_history": {
          "description": "Embedded party_history",
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/$defs/party_history_response"
              }
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        },
        "comment_history": {
          "description": "Embedded service_provider_product_suspension_comment_history",
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/$defs/service_provider_product_suspension_comment_history_response"
              }
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        }
      },
      "required": [
        "id",
        "procuring_system_operator_id",
        "service_provider_id",
        "product_type_ids",
        "reason",
        "recorded_at",
        "recorded_by",
        "service_provider_product_suspension_id"
      ]
    },
    "service_provider_product_suspension_reason": {
      "description": "The reason for the suspension.",
      "format": "text",
      "type": "string",
      "enum": [
        "communication_issues",
        "failing_heartbeat",
        "system_issues",
        "clearing_issues",
        "breach_of_conditions",
        "other"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/elhub-service-provider-product-suspension-history-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.