Metering Changes Schema Reference
This page summarizes the request and response contract for the Metering Changes API.
Headers and Parameters
| Field | Location | Required | Type | Format / Constraints |
|---|---|---|---|---|
X-API-KEY | Header | Yes | string | UUID format |
X-IDEMPOTENCY-KEY | Header | Yes | string | Non-empty string |
X-TEST-MODE | Header | No | string | true enables test mode |
mpid | Path | Yes | string | Supplier MPID |
Request Schema (MeteringChangesRequestSchema)
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
mpan_core | Yes | integer | Exactly 13 digits, numeric |
appointment_date | No | string or null | YYYYMMDD; must not be in the past |
earliest_appointment_time | No | string or null | HHMMSS |
latest_appointment_time | No | string or null | HHMMSS; if both times are provided, must be greater than or equal to earliest_appointment_time |
requested_energisation_status | Yes | string | E or D |
additional_information | No | string or null | Max 200 chars |
remove_all_meters | No | boolean or null | Boolean |
retrieval_method | Yes in API requests | string | One of H, M, N, R, S, U |
ssc_id | No | string or null | Max 4 chars |
metering_system_nsfc | No | string or null | Max 10 chars |
communications_method | No | string or null | Max 10 chars |
Additional validation:
- Extra/unknown fields are rejected.
retrieval_methodis required for API requests.
Response Schema (MeteringChangesResponseSchema)
Used in GET /requests/v1/{mpid} when request_type=metering-changes.
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
appointment_date | No | string(date) or null | Date |
earliest_appointment_time | No | string(time) or null | Time |
latest_appointment_time | No | string(time) or null | Time |
requested_energisation_status | Yes | string | Stored value |
additional_information | No | string or null | Free text |
remove_all_meters | No | boolean or null | Boolean |
standard_settlement_configuration | No | string or null | Returned when available |
retrieval_method | No | string or null | Returned when available |
metering_system_non_settlement_functionality_code | No | string or null | Returned when available |
communications_method | No | string or null | Returned when available |
fault_resolution_report | No | object or null | Additional failure details when available |
notification_of_failure | No | object or null | Failure notification data when available |
comms_hub_info | No | object or null | Communications hub details when available |
smart_reads | No | array or null | Smart read details when available |
standard_settlement_configuration_id | No | string or null | Returned when available |
error_response_message | No | string or null | Error details when available |
new_meter_details | No | object or null | New meter details when available |
removed_meters_details | No | object or null | Removed meter details when available |
hh_mtd | No | array, object, or null | Half-hourly meter technical details when available |
Process Response Schema (SupplierProcessResponseSchema)
Used by POST /metering-changes/v1/{mpid}.
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
request_id | Yes | string | UUID |
request_type | Yes | string | Process type name |
request_status | Yes | string(enum) | Pending, Success, Failed |
description | No | string or null | Process type description |
created_at | Yes | string(datetime) | ISO 8601 datetime |
last_updated_at | Yes | string(datetime) | ISO 8601 datetime |
mpan_core | Yes | integer | MPAN core |