Change of Energisation Schema Reference
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 |
mpid | Path | Yes | string | Supplier MPID |
Request Schema (ChangeOfEnergisationRequestSchema)
| Field | Required | Type | Format / Constraints |
|---|
mpan_core | Yes | integer | Exactly 13 digits, numeric |
requested_energisation_status | Yes | string(enum) | E for energised, D for de-energised |
Additional validation notes:
- Unknown fields are explicitly rejected.
- Allowed values for
requested_energisation_status are E and D.
Response Schema (SupplierProcessResponseSchema)
| 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 | Optional process description |
created_at | Yes | string(datetime) | ISO 8601 datetime |
last_updated_at | Yes | string(datetime) | ISO 8601 datetime |
mpan_core | Yes | integer | MPAN core |