Tutorial Addendum on Web Account and SOAP - SOAP Bulletin Anatomy

SOAP Accountability Message

    

A SOAP accountability bulletin is a appropriate SOAP bulletin acclimated to backpack absurdity information.

    

It haveto accept alone one physique adolescent aspect alleged "Fault" aspect with the afterward structure:

    

 

    
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">

    
 <env:Header>

    
  ...

    
 </env:Header>

    
 <env:Body>

    
  <env:Fault>

    
   <env:Code> (required)

    
    <env:Value>env:VersionMismatch | env:MustUnderstand | Sender

    
       | DataEncodingUnknown | Receiver</env:Value> (required)

    
    <env:Subcode> (optional)

    
     <env:Value>text</env:Value> (required)

    
      <env:Subcode> (optional)

    
       ...

    
      </env:Subcode>

    
    </env:Subcode>

    
   </env:Code>

    
   <env:Reason> (required)

    
    <env:Text xml:lang="languageCode">text<env:Text> (required)

    
    <env:Text xml:lang="languageCode">text<env:Text> (opitonal)

    
    ...

    
   </env:Reason>

    
   <env:Node> (optional)

    
    http://.com/processingNode

    
   </env:Node>

    
   <env:Role> (optional)

    
    http://.com/processingRole

    
   </env:Role>

    
   <env:Detail ...> (optional)

    
    ... (any   XML   structure)

    
   </env:Detail>

    
  </env:Fault>

    
 </env:Body>

    
</env:Envelope>

    

Note that:

    

    
• "Fault" haveto be the alone adolescent aspect of "Body".
  
      



    
• "Code" and "Reason" are appropriate adolescent elements. "Node", "Role" and "Detail" are alternative adolescent elements.
  
      



    
• "Code", "Reason", "Node", "Role" and "Detail" haveto arise in the predefined order.
  
      



    
• "Code.Value" is a appropriate element. It haveto accommodate one of the 5 predefined values.
  
      



    
• "Subcode.Value" is aswell a appropriate element. But it may accommodate any argument infomation.
  
      



    
• "Code.Subcode" is an alternative element.
  
      



    
• "Subcode.Subcode" is a recursive structure.
  
      



    
• The first "Reason.Text" aspect is required. Added "Reason.Text elements are optional.
  
      



    
• "Reason.Text[@xml:lang]" is a appropriate attribute, which specifies an XML accepted accent code.
  
      



    
• "Node" specifies which SOAP bulge generated this accountability message.
  
      



    
• "Role" specifies what role this bulge was arena if this accountability occurred.
  
      



    
• "Detail" is chargeless architecture XML anatomy to supplier any abundant accountability information.
  
      



    

To accord an abstraction of how a SOAP accountability bulletin looks like, I accept affected the archetype #6a from the SOAP 1.2 blueprint here:

    

 

    
<?xml version= 1.0  ?>

    
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"

    
            xmlns:rpc= http://www.w3.org/2003/05/soap-rpc >

    
  <env:Body>

    
   <env:Fault>

    
     <env:Code>

    
       <env:Value>env:Sender</env:Value>

    
       <env:Subcode>

    
        <env:Value>rpc:BadArguments</env:Value>

    
       </env:Subcode>

    
     </env:Code>

    
     <env:Reason>

    
      <env:Text xml:lang="en-US">Processing error</env:Text>

    
      <env:Text xml:lang="fr-CA">Error</env:Text>

    
     </env:Reason>

    
     <env:Detail>

    
      <e:myFaultDetails 

    
        xmlns:e="http://travelcompany.example.org/faults">

    
        <e:message>Name does not bout agenda number</e:message>

    
        <e:errorcode>999</e:errorcode>

    
      </e:myFaultDetails>

    
     </env:Detail>

    
   </env:Fault>

    
 </env:Body>

    
</env:Envelope>