Skip to main content

Change of Energisation Schema Reference

Headers and Parameters

FieldLocationRequiredTypeFormat / Constraints
X-API-KEYHeaderYesstringUUID format
X-IDEMPOTENCY-KEYHeaderYesstringNon-empty string
mpidPathYesstringSupplier MPID

Request Schema (ChangeOfEnergisationRequestSchema)

FieldRequiredTypeFormat / Constraints
mpan_coreYesintegerExactly 13 digits, numeric
requested_energisation_statusYesstring(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)

FieldRequiredTypeFormat / Constraints
request_idYesstringUUID
request_typeYesstringProcess type name
request_statusYesstring(enum)Pending, Success, Failed
descriptionNostring or nullOptional process description
created_atYesstring(datetime)ISO 8601 datetime
last_updated_atYesstring(datetime)ISO 8601 datetime
mpan_coreYesintegerMPAN core