GET /meter-technical-details/v1/{mpid}?mpan_id=...&as_of=...

Returns current or historical HH/NHH meter technical detail records associated with a supplier MPAN.

Request

Method and path:

• Current snapshot:
  • GET /meter-technical-details/v1/{mpid}?mpan_id=1234567890123
• Historical snapshot:
  • GET /meter-technical-details/v1/{mpid}?mpan_id=1234567890123&as_of=2025-01-01

Headers:

• X-API-KEY (required): string, API key used for tenant authorization.

Path parameters:

• mpid (required): string supplier MPID.

Query parameters:

• mpan_id (required): integer MPAN core.
• as_of (optional): date or ISO 8601 datetime. When provided, returns the MTD snapshot valid at that point in time.

Request body:

• None.

Response

Success:

• 200 OK
• Body type: array of MTDResponseSchema

[
  {
    "mpan_core": 1234567890123,
    "meter_id": "A1B2C3D4E5",
    "meter_type": {
      "market_segment": "A",
      "connection_type": "H",
      "meter_type": "RCAMR",
      "meter_group": "Smart"
    },
    "manufacturer": "Landis+Gyr",
    "meter_installation_datetime": "2025-11-03T09:30:00+00:00",
    "meter_location": "E",
    "meter_removal_datetime": null,
    "effective_from_settlement_date_msmtd": "2025-01-01",
    "hh_mtd": {
      "meter_cop": "5",
      "meter_cop_issue_number": 1,
      "complex_site_indicator": false,
      "esme_id": "19LND12345678901234567",
      "meter_equipment_location": "External cabinet",
      "system_voltage": 230,
      "number_of_phases": 1,
      "additional_information": null,
      "current_rating": 100,
      "vt_ratio": null,
      "ct_ratio": null,
      "phase_wire": "2W",
      "feeder_status": "L",
      "feeder_status_efd": "2025-11-03T00:00:00+00:00",
      "meter_asset_provider_id": "MAP1",
      "meter_asset_provider_efd": "2025-11-03T00:00:00+00:00",
      "outstation_id": "OUTSTN-001",
      "outstation_type": "COM",
      "modem_type": "4G",
      "outstation_number_of_channels": 4,
      "outstation_number_of_dials": 8,
      "outstation_username_level_1": "user1",
      "outstation_password_level_1": "secret1",
      "outstation_username_level_2": null,
      "outstation_password_level_2": null,
      "outstation_username_level_3": null,
      "outstation_password_level_3": null,
      "reader_password": null,
      "communications_method": "IP",
      "communications_method_b": null,
      "dial_in_out_indicator": "O",
      "communications_address": "10.0.0.10",
      "communications_address_b": null,
      "baud_rate": 9600,
      "communications_provider": "BT01",
      "sim_serial_number": "89441122334455667788",
      "sequence_mpan_core": null,
      "sequence_station_id": null,
      "meter_registers": [
        {
          "meter_register_id": "01",
          "outstation_id": "OUTSTN-001",
          "channel_number": "001",
          "pulse_multiplier": 1.0,
          "meter_register_multiplier": 1.0,
          "outstation_multiplier": 1.0,
          "measurement_quantity_id": "AI",
          "number_of_register_digits": 6,
          "associated_meter_id": null,
          "associated_meter_register_id": null
        }
      ]
    },
    "nhh_mtd": null
  }
]

No content cases:

• 204 No Content when the MPAN exists but no linked meter IDs are found.
• 204 No Content when as_of is provided but no MTD version is valid at that point in time.

Not found case:

• 404 when the MPAN does not exist for the supplier.

Auth/tenant errors:

• 401 when credentials cannot access the requested MPID.
• 403 when supplier access is forbidden for the API key.

Behavior notes:

• Meter registers are filtered to those owned by the requested MPAN only.
• Without as_of, the API returns each meter's current version.
• With as_of, the API returns the version where valid_from <= as_of < valid_to (or open-ended current version where valid_to is null).

Full field definitions:

• Schema Reference