lexs:AvailabilityResponseMessage

Element information

Content

• Sequence [1..1]
  from type lexs:SRMessageType
  lexs:SRMessageMetadata [1..1]Metadata about Search/Retrieve message.
  from type lexs:ResponseMessageType
  lexs:ResponseMetadata [1..1]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.
  1. lexs:ServiceAvailableIndicator [1..1]A flag which indicates whether service provider is available. True if the service is available, false 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.
  2. lexs:AdditionalInformation [0..1]Additional Information about the availablity 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

• Type lexssr:getAvailabilityResponseType (Element lexssr:getAvailabilityResponse)

Sample instance

<lexs:AvailabilityResponseMessage>
   <lexs:SRMessageMetadata>
      <lexs:LEXSVersion>3.1.4</lexs:LEXSVersion>
      <lexs:MessageDateTime>2006-12-01T09:30:47.0Z</lexs:MessageDateTime>
      <lexs:MessageSequenceNumber>10</lexs:MessageSequenceNumber>
      <lexs: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>
      </lexs:MessageOriginMetadata>
      <lexs:MessageDestinationIdentifier>
         <nc:OrganizationName>Hypothetical Organization F</nc:OrganizationName>
         <lexs:SystemID>SysF</lexs:SystemID>
      </lexs:MessageDestinationIdentifier>
   </lexs:SRMessageMetadata>
   <lexs:ResponseMetadata>
      <lexs:ResultCode>Success</lexs:ResultCode>
      <lexs:InResponseToMessageSequenceNumber>9</lexs:InResponseToMessageSequenceNumber>
   </lexs:ResponseMetadata>
   <lexs:ServiceAvailableIndicator>true</lexs:ServiceAvailableIndicator>
   <lexs:AdditionalInformation>ABC data source will be down until 1:00 PM</lexs:AdditionalInformation>
</lexs:AvailabilityResponseMessage>