Elhub · Schema

product_type_response

Response schema - Product type.

CompanyEnergyElectricityData HubMeteringOpen DataNorwayUtilities

Properties

Name Type Description
id integer Unique surrogate identifier.
business_id string The code for this product type.
name string The name of the product type.
service string The service offered by the product type.
products string Examples of products belonging to this product type.
system_operator_product_type object Embedded system_operator_product_type
View JSON Schema on GitHub

JSON Schema

elhub-product-type-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/elhub/json-schema/elhub-product-type-response-schema.json",
  "title": "product_type_response",
  "description": "Response schema - Product type.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/elhub-product-type-api-openapi.yml#/components/schemas/product_type_response",
  "summary": "Response - Product Type",
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique surrogate identifier.",
      "format": "bigint",
      "type": "integer",
      "readOnly": true
    },
    "business_id": {
      "description": "The code for this product type.",
      "format": "text",
      "type": "string",
      "readOnly": true
    },
    "name": {
      "description": "The name of the product type.",
      "format": "text",
      "type": "string",
      "maxLength": 64,
      "readOnly": true
    },
    "service": {
      "description": "The service offered by the product type.",
      "format": "text",
      "type": "string",
      "readOnly": true
    },
    "products": {
      "description": "Examples of products belonging to this product type.",
      "format": "text",
      "type": "string",
      "readOnly": true
    },
    "system_operator_product_type": {
      "description": "Embedded system_operator_product_type",
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/system_operator_product_type_response"
          }
        },
        {
          "type": "null"
        }
      ],
      "nullable": true
    }
  },
  "required": [
    "id",
    "business_id",
    "name",
    "service",
    "products"
  ],
  "$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"
      ]
    },
    "entity_business_id_type": {
      "description": "The type of the business identifier.",
      "format": "text",
      "type": "string",
      "enum": [
        "pid",
        "org",
        "email"
      ]
    },
    "entity_client_response": {
      "summary": "Response - Entity client",
      "description": "Response schema - Client linked to an entity for client credentials and JWT grant authentication methods.",
      "type": "object",
      "properties": {
        "id": {
          "description": "Unique surrogate identifier.",
          "format": "bigint",
          "type": "integer",
          "readOnly": true
        },
        "entity_id": {
          "description": "Reference to the entity that this client is attached to.",
          "format": "bigint",
          "type": "integer"
        },
        "name": {
          "description": "Name of the client.",
          "format": "text",
          "type": [
            "string",
            "null"
          ],
          "maxLength": 256
        },
        "client_id": {
          "description": "The identifier of the entity. For use with client credentials authentication method.",
          "format": "text",
          "type": "string",
          "readOnly": true
        },
        "party_id": {
          "description": "Reference to the party this client allows to assume. A null value means the client cannot assume any party.",
          "format": "bigint",
          "type": [
            "integer",
            "null"
          ]
        },
        "scopes": {
          "description": "List of scopes granted to the user when it logs in as an entity or when it acts as the party. When assuming a party through party membership, the least privileged set of scopes will be kept.\nScopes 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
        },
        "client_secret": {
          "description": "The secret of the entity. For use with client credentials authentication method. Input as plain text but stored encrypted.",
          "format": "text",
          "type": [
            "string",
            "null"
          ],
          "minLength": 12
        },
        "public_key": {
          "description": "The public key of the entity (X.509 SubjectPublicKeyInfo). For use with JWT grant authentication method.",
          "format": "text",
          "type": [
            "string",
            "null"
          ],
          "pattern": "^-----BEGIN PUBLIC KEY-----\\nMIIB[-A-Za-z0-9+/\\n]*={0,3}\\n-----END PUBLIC KEY-----$"
        },
        "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
        },
        "entity": {
          "description": "Embedded entity",
          "oneOf": [
            {
              "$ref": "#/$defs/entity_response"
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        },
        "party": {
          "description": "Embedded party",
          "oneOf": [
            {
              "$ref": "#/$defs/party_response"
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        }
      },
      "required": [
        "id",
        "entity_id",
        "client_id",
        "scopes",
        "recorded_at",
        "recorded_by"
      ]
    },
    "entity_response": {
      "summary": "Response - Entity",
      "description": "Response schema - Entity - Natural or legal person\n\nAn entity is a natural or legal person that can be a party in the Flexibility Information System.\n\nExample entity types:\n\n* Person\n* Organisation",
      "type": "object",
      "properties": {
        "id": {
          "description": "Unique surrogate identifier.\n\nNote:\nThis is a Primary Key.",
          "format": "bigint",
          "type": "integer",
          "readOnly": true
        },
        "business_id": {
          "description": "The business identifier of the entity. Format depends on `business_id_type`.",
          "format": "text",
          "type": "string"
        },
        "business_id_type": {
          "$ref": "#/$defs/entity_business_id_type"
        },
        "name": {
          "description": "Name of the entity. Maximum 128 characters.",
          "format": "text",
          "type": "string"
        },
        "type": {
          "$ref": "#/$defs/entity_type"
        },
        "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
        },
        "client": {
          "description": "Embedded entity_client",
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/$defs/entity_client_response"
              }
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        },
        "party": {
          "description": "Embedded party",
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/$defs/party_response"
              }
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        },
        "party_membership": {
          "description": "Embedded party_membership",
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/$defs/party_membership_response"
              }
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        },
        "identity": {
          "description": "Embedded identity",
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/$defs/identity_response"
              }
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        }
      },
      "required": [
        "id",
        "business_id",
        "business_id_type",
        "name",
        "type",
        "recorded_at",
        "recorded_by"
      ]
    },
    "entity_type": {
      "description": "The type of the entity, e.g Person, Organisation",
      "format": "text",
      "type": "string",
      "enum": [
        "person",
        "organisation"
      ]
    },
    "identity_response": {
      "summary": "Response - Identity",
      "description": "Response schema - Resource uniquely identifying a user by linking its entity and the potentially assumed party.",
      "type": "object",
      "properties": {
        "id": {
          "description": "Unique surrogate identifier.",
          "format": "bigint",
          "type": "integer",
          "readOnly": true
        },
        "entity_id": {
          "description": "Reference to the entity using the identity.",
          "format": "bigint",
          "type": "integer",
          "readOnly": true
        },
        "entity_name": {
          "description": "Name of the entity using the identity.",
          "format": "text",
          "type": "string",
          "readOnly": true
        },
        "party_id": {
          "description": "Reference to the party assumed by the entity.",
          "format": "bigint",
          "type": [
            "integer",
            "null"
          ],
          "readOnly": true
        },
        "party_name": {
          "description": "Name of the party assumed by the entity.",
          "format": "text",
          "type": [
            "string",
            "null"
          ],
          "readOnly": true
        },
        "entity": {
          "description": "Embedded entity",
          "oneOf": [
            {
              "$ref": "#/$defs/entity_response"
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        },
        "party": {
          "description": "Embedded party",
          "oneOf": [
            {
              "$ref": "#/$defs/party_response"
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        }
      },
      "required": [
        "id",
        "entity_id",
        "entity_name"
      ]
    },
    "party_business_id_type": {
      "description": "The type of the business identifier.",
      "format": "text",
      "type": "string",
      "default": "uuid",
      "enum": [
        "gln",
        "uuid",
        "eic_x",
        "org"
      ]
    },
    "party_membership_response": {
      "summary": "Response - Party Membership",
      "description": "Response schema - The relation between a party and entity.",
      "type": "object",
      "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": {
          "description": "Embedded party",
          "oneOf": [
            {
              "$ref": "#/$defs/party_response"
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        },
        "entity": {
          "description": "Embedded entity",
          "oneOf": [
            {
              "$ref": "#/$defs/entity_response"
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        }
      },
      "required": [
        "id",
        "party_id",
        "entity_id",
        "scopes",
        "recorded_at",
        "recorded_by"
      ]
    },
    "party_response": {
      "summary": "Response - Party",
      "description": "Response schema - The body that interacts with the Flexibility Information System\n\nA party is the thing that is authorized to access or modify data in the Flexiblity Information System.\n\nExample party types:\n\n* Service Provider\n* System Operator\n* End User",
      "type": "object",
      "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
        },
        "entity": {
          "description": "Embedded entity",
          "oneOf": [
            {
              "$ref": "#/$defs/entity_response"
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        }
      },
      "required": [
        "id",
        "business_id",
        "business_id_type",
        "entity_id",
        "name",
        "role",
        "type",
        "status",
        "recorded_at",
        "recorded_by"
      ]
    },
    "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"
      ]
    },
    "product_type_response": {
      "summary": "Response - Product Type",
      "description": "Response schema - Product type.",
      "type": "object",
      "properties": {
        "id": {
          "description": "Unique surrogate identifier.",
          "format": "bigint",
          "type": "integer",
          "readOnly": true
        },
        "business_id": {
          "description": "The code for this product type.",
          "format": "text",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "The name of the product type.",
          "format": "text",
          "type": "string",
          "maxLength": 64,
          "readOnly": true
        },
        "service": {
          "description": "The service offered by the product type.",
          "format": "text",
          "type": "string",
          "readOnly": true
        },
        "products": {
          "description": "Examples of products belonging to this product type.",
          "format": "text",
          "type": "string",
          "readOnly": true
        },
        "system_operator_product_type": {
          "description": "Embedded system_operator_product_type",
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/$defs/system_operator_product_type_response"
              }
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        }
      },
      "required": [
        "id",
        "business_id",
        "name",
        "service",
        "products"
      ]
    },
    "system_operator_product_type_response": {
      "summary": "Response - System Operator Product Type",
      "description": "Response schema - Relation between a system operator and a product type they want to buy.",
      "type": "object",
      "properties": {
        "id": {
          "description": "Unique surrogate identifier.",
          "format": "bigint",
          "type": "integer",
          "readOnly": true
        },
        "system_operator_id": {
          "description": "Reference to the system operator.",
          "format": "bigint",
          "type": "integer"
        },
        "product_type_id": {
          "description": "Reference to the product type.",
          "format": "bigint",
          "type": "integer"
        },
        "status": {
          "$ref": "#/$defs/system_operator_product_type_status",
          "default": "active"
        },
        "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
        },
        "system_operator": {
          "description": "Embedded party",
          "oneOf": [
            {
              "$ref": "#/$defs/party_response"
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        },
        "product_type": {
          "description": "Embedded product_type",
          "oneOf": [
            {
              "$ref": "#/$defs/product_type_response"
            },
            {
              "type": "null"
            }
          ],
          "nullable": true
        }
      },
      "required": [
        "id",
        "system_operator_id",
        "product_type_id",
        "status",
        "recorded_at",
        "recorded_by"
      ]
    },
    "system_operator_product_type_status": {
      "description": "The status of the relation.",
      "format": "text",
      "type": "string",
      "default": "active",
      "enum": [
        "active",
        "inactive"
      ]
    }
  }
}

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-product-type-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.