Schema Central  >  LEXS 4.0  >  ulex.xsd  >  ulex:AvailabilityResponseMessage
Advanced search
Need NIEM Help?

Recommended Reading:

Definitive XML Schema

 

Advanced XML Applications

 

ulex:AvailabilityResponseMessage

A response to a getAvailabilityRequest. Shows the status of the service provider.

Element information

Namespace: http://ulex.gov/ulex/2.0

Schema document: ulex.gov/ulex/2.0/ulex.xsd

Type: ulex:AvailabilityResponseMessageType

Properties: Global, Qualified

Content

  • Sequence [1..1]
    1. ulex:SRMessageMetadata [1..1]Metadata about an SR message.
    2. ulex:ResponseMetadata [1..1]Metadata about 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). This element is included in all response results.
    3. ulex:ServiceAvailableIndicator [1..1]True if the service provider is available; false otherwise (if there are problems, such as the database is down for maintenance). Note, that if there is no reply to the getAvailabilityRequest, it may indicate that the service provider is down, that there are network problems, that the requestor is not properly configured, etc.
    4. ulex:AdditionalInformationText [0..1]A set of additional information about the availability of a service provider. Element is populated by the service provider and can be used when the service is available, for example to indicate that a data owner is unavailable, or when the service is not available, for example to indicate that the service provider will be back up at a particular time.

Attributes

None

Used in

Sample instance

<ulex:AvailabilityResponseMessage>
   <ulex:SRMessageMetadata>
      <ulex:ULEXFrameworkVersionText>2.0</ulex:ULEXFrameworkVersionText>
      <ulex:ULEXImplementation>
         <ulex:ULEXImplementationVersionText>4.0</ulex:ULEXImplementationVersionText>
         <ulex:ULEXImplementationName>LEXS</ulex:ULEXImplementationName>
      </ulex:ULEXImplementation>
      <ulex:MessageDateTime>2006-12-17T09:30:47.0Z</ulex:MessageDateTime>
      <wsa:MessageID>uuid:d03bff59-7323-4f60-b080-fc2b1d873f0c</wsa:MessageID>
      <wsa:RelatesTo>uuid:ab19b2f2-d64c-44c6-ab18-61dde2f25e6a</wsa:RelatesTo>
      <ulex:MessageOriginMetadata>
         <lexs:SystemIdentifier>
            <nc:OrganizationName>Hypothetical Organization E</nc:OrganizationName>
            <lexs:SystemID>SysE</lexs:SystemID>
         </lexs:SystemIdentifier>
         <lexs:SystemContact>
            <nc:PersonGivenName>Jim</nc:PersonGivenName>
            <nc:PersonSurName>West</nc:PersonSurName>
            <nc:ContactTelephoneNumber>
               <nc:FullTelephoneNumber>
                  <nc:TelephoneNumberFullID>770-555-1212</nc:TelephoneNumberFullID>
               </nc:FullTelephoneNumber>
            </nc:ContactTelephoneNumber>
         </lexs:SystemContact>
      </ulex:MessageOriginMetadata>
      <lexs:MessageDestinationIdentifier>
         <nc:OrganizationName>Hypothetical Organization F</nc:OrganizationName>
         <lexs:SystemID>SysF</lexs:SystemID>
      </lexs:MessageDestinationIdentifier>
   </ulex:SRMessageMetadata>
   <ulex:ResponseMetadata>
      <ulex:ResultCode>Success</ulex:ResultCode>
   </ulex:ResponseMetadata>
   <ulex:ServiceAvailableIndicator>true</ulex:ServiceAvailableIndicator>
   <ulex:AdditionalInformationText>ABC data source will be down until 1:00 PM</ulex:AdditionalInformationText>
</ulex:AvailabilityResponseMessage>