<- 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 with ErrorType: schemaViolation, missingField, invalidValue, signatureFailure, hashMismatch, unsupportedAlgorithm, unsupportedProfile, policyViolation, internalError or other.
  • Provide a human-readable ErrorMessage.
  • Optionally include MInstanceID, ErrorTime (when the error occurred) and 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”.
MInstanceID ID of the M-Instance.
ErrorID Unique identifier of the error instance.
ErrorTime Time at which the error occurred.
ErrorType Classification of the error: schemaViolation, missingField, invalidValue, signatureFailure, hashMismatch, unsupportedAlgorithm, unsupportedProfile, policyViolation, internalError, other.
ErrorMessage Human-readable description of the error.
ErrorDetails Optional detailed information about the error.
– Field Field associated with the error, if applicable.
– Expected Expected value or condition.
– 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