lexs:AdvisoryType
A structure that describes details about errors or warnings. Advisory is not used if the result code is Success. However, if there is an error or warning, there must be one or more advisory elements to provide additional details about the error or warning.
Complex type information
Namespace: http://usdoj.gov/leisp/lexs/3.1
Schema document: lexs/3.1/lexs.xsd
NIEM Properties:
- Base: s:ComplexObjectType
Content
- Sequence [1..1]
- lexs:AdvisoryCategory [1..1]Provides a machine-interpretable error/warning message from an enumerated code list that can be used programmatically.
- lexs:AdvisoryText [0..1]Free form text describing the warning or error. Since this text may be provided to end-users, service providers should populate this text field with user friendly messages rather than technical jargon or stack traces.
Attributes
| Name | Occ | Type | Description | Notes |
|---|---|---|---|---|
| s:id | [0..1] | xsd:ID | The id attribute is used to define XML IDs for NIEM objects. These IDs may be targets of reference elements, metadata attributes, and link metadata attributes. | from type s:ComplexObjectType |
| s:metadata | [0..1] | xsd:IDREFS | The attribute metadata allows an object to point to metadata that affects itself. | from type s:ComplexObjectType |
| s:linkMetadata | [0..1] | xsd:IDREFS | The linkMetadata attribute allows an element to point to metadata that affects the relationship between the context and the value of the object. | from type s:ComplexObjectType |
Used in
- Element lexs:Advisory
- NIEM reference target from lexslib:ObjectReference
- NIEM reference target from lexslib:PayloadObjectReference
- NIEM reference target from lexslib:SameAsDigestReference
Type inheritance chain
- s:ComplexObjectType
- extended by lexs:AdvisoryType