<- Go to Data Types    Go to ToC

1. Definition 2. Functional Requirements 3. Syntax 4. Semantics

1 Definition

An Error Code identifies and describes an error condition occurring during the execution of PTF components, including trust establishment, verification, and data processing.

2 Functional Requirements

An Error Code shall:

  • Include a Header identifying the version of the Error Code structure.
  • Include an ErrorID uniquely identifying the error instance.
  • Classify the error using ErrorType.
  • Provide a human‑readable ErrorMessage.
  • Optionally include ErrorTime indicating when the error occurred.
  • Optionally include ErrorDetails describing field‑level or value‑level discrepancies.
  • Optionally include DataXMData and DescrMetadata.
  • Use only the keys defined in this Data Type.

3 Syntax

https://schemas.mpai.community/PTF/V1.0/data/ErrorCode.json

4 Semantics

Label Description
Header Error Code Header — Standard “PTF-ERR-V”.
ErrorID Unique identifier of the error instance.
ErrorType Classification of the error.
ErrorMessage Human‑readable description of the error.
ErrorTime Time at which the error occurred.
ErrorDetails Optional detailed information about the error.
ErrorDetails.Field Field associated with the error.
ErrorDetails.Expected Expected value or condition.
ErrorDetails.Found Actual value or condition found.
DataXMData Metadata that the Process/AIM exchanges with other Process/AIM.
DescrMetadata Descriptive metadata (max length 2048).

<- Go to Data Types    Go to ToC