lexs:ResponseMetadata
Metadata for the response message indicates whether the request resulted in an error or warning or success(ResultCode), provides additional information about the result in cases of error or warning(Advisory), and provides an identifier for the message this is the result for(InResponseToMessageSequenceNumber). This element is included in all results.
Element information
Namespace: http://usdoj.gov/leisp/lexs/3.1
Schema document: lexs/3.1/lexs.xsd
Type: lexs:ResponseMetadataType
Properties: Global, Qualified
Content
- Sequence [1..1]
- lexs:ResultCode [1..1]Response status code value
- lexs:Advisory [0..*]Container for the advisory details.
- lexs:InResponseToMessageSequenceNumber [1..1]Uniquely identifies the request message that resulted in this response.
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:MetadataType |
Used in
- Type lexs:ResponseMessageType
- Type lexs:AttachmentResponseMessageType via extension of lexs:ResponseMessageType (Element lexs:AttachmentResponseMessage)
- Type lexs:AvailabilityResponseMessageType via extension of lexs:ResponseMessageType (Element lexs:AvailabilityResponseMessage)
- Type lexs:CapabilitiesResponseMessageType via extension of lexs:ResponseMessageType (Element lexs:CapabilitiesResponseMessage)
- Type lexs:DataItemResponseMessageType via extension of lexs:ResponseMessageType (Element lexs:DataItemResponseMessage)
- Type lexs:DataOwnersResponseMessageType via extension of lexs:ResponseMessageType (Element lexs:DataOwnersResponseMessage)
- Type lexs:DomainResponseMessageType via extension of lexs:ResponseMessageType (Element lexs:DomainResponseMessage)
- Type lexs:SearchResponseMessageType via extension of lexs:ResponseMessageType (Element lexs:SearchResponseMessage)
Sample instance
<lexs:ResponseMetadata> <lexs:ResultCode>Success</lexs:ResultCode> <lexs:InResponseToMessageSequenceNumber>7</lexs:InResponseToMessageSequenceNumber> </lexs:ResponseMetadata>