Reports Schema Notes

This API does not take a request body and returns ReportMessageSchema items.

Request Parameters

Field	Location	Required	Type	Format / Constraints	Notes
X-API-KEY	Header	Yes	string	Not specified in schema	Required for supplier authorization.
mpid	Path	Yes	string	Not specified	Supplier MPID.
received_start	Query	No	string(datetime)	ISO 8601 datetime	Start of the received datetime range.
received_end	Query	No	string(datetime)	ISO 8601 datetime	End of the received datetime range.

Additional validation:

• If both received_start and received_end are present, received_start must be before or equal to received_end.

Response Schema (ReportMessageSchema)

Field	Required	Type	Format / Constraints	Notes
id	Yes	string	UUID	Market system message ID.
inbound_outbound	Yes	string(enum)	Direction value	Typically inbound or outbound.
status	Yes	string(enum)	Message status value	Message processing state.
created	No	string(datetime) or null	ISO 8601 datetime	Message creation timestamp.
updated	No	string(datetime) or null	ISO 8601 datetime	Last update timestamp.
interface_id	No	string or null	Not specified	Interface identifier associated with the message.
schema_version	No	string or null	Not specified	Message schema version.
event_code	No	string or null	Not specified	REP message code, for example REP-002.
sender_dip_id	No	string or null	Not specified	Sender DIP ID.
sender_role_id	No	string or null	Not specified	Sender role code.
decoded_message	No	object or null	Free-form JSON object	Decoded report payload.