Smart Transfer of Reads Schema Reference

Headers and Parameters

Field	Location	Required	Type	Format / Constraints
X-API-KEY	Header	Yes	string	UUID format
X-IDEMPOTENCY-KEY	Header (POST)	Yes	string	Non-empty string
mpid	Path	Yes	string	Supplier MPID
mpan_id	Query (GET)	Yes	integer	MPAN core

Request Schema (RegisterLevelReadingRequestSchema)

RegisterLevelReadingRequestSchema uses the same top-level shape as the traditional transfer-of-reads request.

Field	Required	Type	Format / Constraints
mpan_core	Yes	integer	MPAN core
bsc_validation	Yes	string(enum)	F, U, V
meter_readings	Yes	array	List of meter-level readings
meter_readings[].meter_id	Yes	string	Meter identifier
meter_readings[].reading_type	Yes	string	Reading type code
meter_readings[].meter_reading_flag	No	boolean or null	Meter reading direction flag
meter_readings[].register_readings[].meter_register_id	Yes	string	Register identifier
meter_readings[].register_readings[].reading_datetime	Yes	string(datetime)	ISO 8601 datetime
meter_readings[].register_readings[].reading	Yes	string	Reading value
meter_readings[].register_readings[].md_reset_datetime	No	string(datetime) or null	ISO 8601 datetime
meter_readings[].register_readings[].md_reset_count	No	integer or null	Maximum demand reset count
meter_readings[].register_readings[].reading_method	Yes	string	Reading method code

Smart Reading Item Schema (PUB041SmartTransferOfReadsSchema)

Used in pre_validation_reads and post_validation_reads.

Field	Required	Type	Format / Constraints
meter_id	Yes	string	Max 10 chars
cumulative_register_reading	Yes	string	Regex ^(-)?\d{1,9}(\.\d{1,3})?$
cumulative_register_reading_datetime	Yes	string(datetime)	ISO 8601 datetime
reading_method	Yes	string	One of A, C, E, S, X, Y
site_visit_check_code	No	string or null	Two-digit site visit check code
configurable_register_reading_datetime	Yes	string(datetime)	ISO 8601 datetime
configurable_register_id	Yes	string	Register identifier
configurable_register_reading	Yes	string	Reading value

Response Schema (SmartTransferOfReadsDetailsResponseSchema)

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
pre_validation_reads	No	array or null	List of PUB041SmartTransferOfReadsSchema
post_validation_reads	No	array or null	List of PUB041SmartTransferOfReadsSchema
register_level_readings	No	object or null	RegisterLevelReadingSchema

Process Response Schema (SmartTransferOfReadsResponseSchema)

Used by POST /smart-transfer-of-reads/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