Skip to main content

22 posts tagged with "API"

API changes and improvements.

View All Tags

Release 1.1.28

· 2 min read
SSI Team
Platform Engineering

Highlights

Agents

  • Added GET /agents/v1/{mpid}?dip_id={dip_id} to fetch a single agent by DIP ID, or ignore dip_id to retrieve all agents in DB.

MPAN and Meter Technical Details

  • MPAN payloads now include measurement_class_id.
  • Meter Technical Details endpoint GET /meter-technical-details/v1/{mpid} now accepts:
    • mpan_id (existing query param)
    • as_of (new optional query param for historical view, API will return current snapshot if this is not provided)
  • Meter Technical Details response now includes:
    • effective_from_settlement_date_msmtd
  • Meter registers returned under hh_mtd.meter_registers / nhh_mtd.meter_registers are now filtered to registers owned for that MPAN. This allows for MPAN - Register ownership, rather than MPAN - Meter ownership.

Release 1.1.27 (5 Feb 2026)

· One min read
SSI Team
Platform Engineering

Highlights

  • Added Metering Service and Data Service "Effective To" dates in MPAN API (metering_service_eff_date, data_service_eff_date).
  • Their respective MPID fields will now not turn null on deappointment, with these fields being populated instead.
  • Made effective_from required in metering-service-appointment request type in General Requests API.
  • Added a new type to Change of Regs details API: EnergyDirectionChange.
  • Added a new field to Change of Regs Details type request_scheme in General Requests API.
  • Added 24 - Agents API.
  • Added customer_direct_contact_metering_service_mpid and customer_direct_contract_data_service_mpid to MPAN API.

Release 1.1.26 (23 Dec 2025)

· One min read
SSI Team
Platform Engineering

Highlights

  • Made the following fields nullable in NHH Meter Technical Details Response Schema: meter_cop, current_rating, meter_location, meter_asset_provider_id, meter_asset_provider_efd, retrieval_method, retrieval_method_efd.
  • Made the following fields nullable in NHH Meter Register Details Response Schema type measurement_quantity_id, multiplier, mah_check_indicator, register_digits.
  • Made the following fields nullable in the response block of Meter Technical Details: meter_type, manufacturer, meter_installation_datetime, meter_location.
  • Made recipients dip_id in Readings API response nullable.
  • Added 23 - Transfer of Reads-Disputes API.
  • Updated traditional-transfer-of-reads response schema in 99 - General Requests.
  • MarketSegmentChange has been added to the types allowed in Change of Reg Details API.
  • Added ReadingUnobtainable notification type to Notifications API for D0004 tracking.

Release 1.1.25 (13 Oct 2025)

· One min read
SSI Team
Platform Engineering

Highlights

  • Added MPAN Migration Events to MPAN API.
  • Added LSS Endpoints to 07 - Settlement API.
  • Added Notifications - 18 API.
  • Added Readings - 19 API.
  • Added Default Consumption in 07 - Settlement API.
  • Added Metered Status Change and DUoS Tariff Change to types of Change of Reg Details.
  • Added request_data fields for change-of-reg-details process type in 99 - General Requests.
  • Added Data Service Notifications - 20 API.
  • Added Reports - 21 API.
  • Added Consumption-Amendment - 22 API.
  • Added consumption-amendment request type to 99 - General Requests.

Release 1.1.24 (16 Sep 2025)

· One min read
SSI Team
Platform Engineering

Highlights

  • Fixed typo in MPAN details for CDCS ETD and EFD (word service was missing).
  • Added readings to change-of-energisation process request_data body in Requests API.
  • Added connectionTypeChange as a Change of Registration Details type that can be triggered externally.
  • Added meter_removal_datetime to MTDs.

Release 1.1.23 (3 Sep 2025)

· One min read
SSI Team
Platform Engineering

Highlights

  • Added new request types in Change of Reg Details applicable to DNO-generated requests only (CDO).
  • Added CDC EFD and EFT fields in MPAN API.
  • ct_ratio has been moved from NHH Register Details to NHH Meter Details in MTD API.

Release 1.1.21 (11 Jul 2025)

· One min read
SSI Team
Platform Engineering

Highlights

  • Added metering-changes details to General Requests API in full for request_data.
  • Added annual_information details to Annual Consumption request_data in /requests API.
  • site_visit_check_code updated to site_visit_information in Traditional Transfer of Reads request_data schema in /requests API.

Release 1.1.20 (4 Jul 2025)

· One min read
SSI Team
Platform Engineering

Highlights

  • Made site_visit_check_code nullable in 11 - Transfer of Reads-Losing response schema.
  • Removed reading_validation_result from 11 - Transfer of Reads-Losing response schema, to adjust for expected logic.
  • Renamed meter_reading_flag to accept_readings in 11 - Transfer of Reads-Losing request schema for POST endpoint.
  • Made psr_expiry_date nullable in PSR Details API.
  • mailing_address_postcode has been made nullable in Contact Details API.
  • MPAN API response schemas have had comments added to clarify optional nullability.
  • Comments regarding conditional nullability for psr_expiry_date and additional_information have been added in PSR API.

Release 1.1.19 (27 Jun 2025)

· One min read
SSI Team
Platform Engineering

Highlights

  • Updated GET endpoint in 11 - Traditional Transfer of Reads (Losing) to add request_received_datetime to response body.
  • Added incoming_outgoing_supplier to traditional-transfer-of-reads request type response body in General Requests API.
  • Updated linked and related blocks in MPAN API to provide more information on effective from/to dates and importer/export suppliers.
  • Added additional fields in change-of-energisation schema in General Requests API.