Skip to main content

GET /smart-transfer-of-reads/v1/{mpid}?mpan_id=...

Returns the latest sequence of smart transfer-of-reads messages for one MPAN, including pre-validation readings, post-validation readings, and any register-level D0010 content.

Request​

Method and path:

  • GET /smart-transfer-of-reads/v1/{mpid}?mpan_id=1234567890123

Headers:

  • X-API-KEY (required): string, API key in UUID format.

Path parameters:

  • mpid (required): string supplier MPID.

Query parameters:

  • mpan_id (required): integer MPAN core.

Request body:

  • None.

Response​

Success:

  • 200 OK
  • Body type: SmartTransferOfReadsDetailsResponseSchema
{
  "request_id": "72f30f06-afcc-4ad8-8c1f-78e556ea9cbc",
  "request_type": "smart-transfer-of-reads",
  "request_status": "Pending",
  "description": "Smart Transfer of Reads Process",
  "created_at": "2026-03-11T14:04:22+00:00",
  "last_updated_at": "2026-03-11T14:04:22+00:00",
  "mpan_core": 1234567890123,
  "pre_validation_reads": [
    {
      "meter_id": "A123456789",
      "cumulative_register_reading": "789.0",
      "cumulative_register_reading_datetime": "2022-03-21T19:05:00+00:00",
      "reading_method": "A",
      "site_visit_check_code": "01",
      "configurable_register_reading_datetime": "2022-03-21T19:05:00+00:00",
      "configurable_register_id": "01",
      "configurable_register_reading": "789.0"
    }
  ],
  "post_validation_reads": null,
  "register_level_readings": null
}

No content case:

  • 204 No Content when no smart ToR process exists for the MPAN.

Bad request case:

  • 400 when the MPAN does not exist.

Field-level constraints: