DiagnosticInfo values shall be encoded as a JSON object with the fields shown in Table 34.
Table 34 – JSON Object Definition for a DiagnosticInfo
|
Name |
Data Type |
Description |
|
SymbolicId |
Int32 |
A symbolic name for the status code. The default value is -1. |
|
NamespaceUri |
Int32 |
A namespace that qualifies the symbolic id. The default value is -1. |
|
Locale |
Int32 |
The locale used for the localized text. The default value is -1. |
|
LocalizedText |
Int32 |
A human readable summary of the status code. The default value is -1. |
|
AdditionalInfo |
String |
Detailed application specific diagnostic information. The default value is null. |
|
InnerStatusCode |
StatusCode |
A status code provided by an underlying system. The default value is Good. |
|
InnerDiagnosticInfo |
DiagnosticInfo |
Diagnostic info associated with the inner status code. The default value is null. |
Each field is encoded using the rules defined for the built-in type specified in the Data Type column. Fields should be omitted if the value is null or the default value for the field. If a field is not present the value shall be interpreted as the default value.
The SymbolicId, NamespaceUri, Locale and LocalizedText fields are encoded as JSON numbers which reference the StringTable contained in the ResponseHeader.