Readings Schema Reference
Shared Parameters
| Field | Location | Required | Type | Format / Constraints |
|---|---|---|---|---|
X-API-KEY | Header | Yes | string | Not specified in schema |
X-IDEMPOTENCY-KEY | Header (POST /send) | Yes | string | Non-empty string in practice |
mpid | Path | Yes | string | Supplier MPID |
received_on | Query (GET) | Yes | string | ISO 8601 datetime |
mpan_id | Query (GET) | No | integer | 13 digits in practice |
GET Response Schema (ReadingResponse)
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
id | Yes | string | UUID |
received_on | Yes | string(datetime) | ISO 8601 datetime |
reading_type | Yes | string(enum) | Reading type code from the API contract |
sender_mpid | Yes | string | Not specified |
sender_role | Yes | string | Not specified |
receiver_mpid | Yes | string | Not specified |
receiver_role | Yes | string | Not specified |
mpan_core | Yes | integer | Positive 13-digit integer in practice |
cumulative_readings | No | array of CumulativeReadingMeterResponse | N/A |
CumulativeReadingMeterResponse
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
meter_id | Yes | string | Not specified |
cumulative_register_reading | No | string or null | Not specified |
cumulative_reading_datetime | No | string(datetime) or null | ISO 8601 datetime |
reading_method | No | string or null | Single-character code |
site_visit_check_code | No | string or null | Two-character code |
site_visit_additional_information | No | string or null | Not specified |
registers | No | array of CumulativeReadingMeterRegisterResponse | N/A |
CumulativeReadingMeterRegisterResponse
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
register_id | Yes | string | Not specified |
register_reading | Yes | string | Not specified |
register_reading_datetime | Yes | string(datetime) | ISO 8601 datetime |
number_of_md_resets | No | integer or null | Not specified |
md_reset_datetime | No | string(datetime) or null | ISO 8601 datetime |
meter_reading_flag | No | boolean or null | N/A |
reading_method | No | string or null | Not specified |
reason_code | No | string or null | Not specified |
reading_status | No | boolean or null | N/A |
site_visit_check_code | No | string or null | Not specified |
site_visit_check_code_additional_information | No | string or null | Not specified |
POST Request Schema (SendReadingsSchema)
| Field | Required | Type | Format / Constraints | Notes |
|---|---|---|---|---|
reading_type | Yes | string(enum) | Must be a supported reading type code | Unknown values are rejected. |
mpan_core | Yes | integer | Positive 13-digit integer | |
meter_id | Yes | string | Non-empty, max 10 chars | |
cumulative_reading_datetime | Conditional | string(datetime) or null | ISO 8601 datetime | Required when cumulative_register_reading is provided. |
reading_method | Conditional | string or null | Regex ^[A-Z]{1}$ | Required when cumulative_register_reading is provided. |
cumulative_register_reading | Conditional | string or null | Not specified | Used for single cumulative reading submission. |
site_visit_check_code | No | string or null | Two-character code | |
register_readings | No | array of CumulativeReadingMeterRegisterCreate | At least one item when supplied; duplicate register_id values rejected |
CumulativeReadingMeterRegisterCreate
| Field | Required | Type | Format / Constraints |
|---|---|---|---|
register_id | Yes | string | 1-2 chars; must match ^[A-Z0-9]{1,2}$ |
register_reading | Yes | string | Not specified |
register_reading_datetime | Yes | string(datetime) | ISO 8601 datetime |
POST Response Schema Notes
The route returns an object with these fields:
message_id: string UUID-like identifier for the reading message.recipients_dip_id: array of string arrays or null (for example,[["DIP-DC-001"]]).status: string message status.sent_datetime: ISO 8601 datetime string.mpan_core: integer MPAN core.