Data Service Notifications Schema Reference
Shared Parameters
| Field | Location | Required | Type | Format / Constraints |
|---|---|---|---|---|
X-API-KEY | Header | Yes | string | Not specified in schema |
X-IDEMPOTENCY-KEY | Header | Yes | string | Non-empty string |
mpid | Path | Yes | string | Supplier MPID |
Request Schema
| Field | Required | Type | Format / Constraints | Notes |
|---|---|---|---|---|
mpan_core | Yes | integer | Positive 13-digit integer | |
event_code | Yes | string(enum) | One of SN-Vacant, SN-NoComms, SN-RemoteEnabled, SN-RemoteDisabled, SN-OffPeakDec | |
supplier_notification_effective_from_date | Conditional | string(datetime) or null | ISO 8601 datetime | Required for all current event codes except SN-OffPeakDec. |
supplier_notification_expiry_date | No | string(datetime) or null | ISO 8601 datetime | |
additional_information | No | string or null | Max 2000 chars | |
meter_id | Conditional | string or null | Max 10 chars | Required for SN-RemoteEnabled and SN-RemoteDisabled. |
off_peak_declarations | Conditional | array or null | Must be a non-empty list for SN-OffPeakDec |
OffPeakDeclaration
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
off_peak_declaration_date | Yes | string(datetime) | ISO 8601 datetime |
off_peak_declaration_proportion | Yes | integer | 0-100 |
Additional validation:
- Extra/unknown fields are rejected.
off_peak_declarationsitems must be objects with both required fields.
Response Schema
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
message_id | Yes | string | Message identifier |
recipients_dip_id | Yes | array of string | Distributor DIP IDs |
status | Yes | string | Not specified |
sent_datetime | Yes | string | ISO 8601 datetime string |
mpan_core | Yes | integer | 13-digit MPAN core |
event_code | Yes | string | Echoes the sent event code |