WSD Scan Service Operation Error Reporting

This section describes how a WSD Scan Service generates and sends operation error codes. Error codes that most operations can return are described in Common WSD Scan Service Operation Error Codes.

When the WSD Scan Service encounters an error while processing an XxxRequest operation, it returns an error code instead of an XxxResponse element. The Scan Service returns error codes in the <soap:Fault> element.

All error messages that are defined within the WSD Scan Service must be sent according to the rules that described in the Web Services Addressing (WS-Addressing) specification. Specifically, the WSD Scan Service should send fault messages, in order, to the following locations:

1. The [fault endpoint], if it is present and valid.

2. Otherwise, the [reply endpoint], if it is present.

3. Otherwise, the [source endpoint].

Endpoints must include required message information headers on all fault messages. Fault messages are correlated as replies by using the [relationship] property as defined in WS-Addressing. The following [action] property designates fault messages:

https://schemas.xmlsoap.org/ws/2004/08/addressing/fault

The definitions of faults use the following properties:

Fault property	Definition
[Code]	The fault code.
[Subcode]	The fault subcode.
[Reason]	The English language reason element.
[Detail]	The detail element. If this element is absent, no detail element is defined for the fault.

These properties bind to a SOAP 1.2 fault as the following code example shows.

<S:Envelope>
  <S:Header>
    <wsa:Action>https://schemas.xmlsoap.org/ws/2004/08/addressing/fault</wsa:Action>
    <!-- Headers excluded for clarity -->
  </S:Header>
  <S:Body>
    <S:Fault>
      <S:Code>
        <S:Value>[Code]</S:Value>
        <S:Subcode>
          <S:Value>[Subcode]</S:Value>
        </S:Subcode>
      </S:Code>
      <S:Reason>
        <S:Text xml:lang="en">[Reason]</S:Text>
      </S:Reason>
      <S:Detail>[Detail]</S:Detail>
    </S:Fault>
  </S:Body>
</S:Envelope>

The following code example shows a sample SOAP Fault.

<soap:Envelope xmlns:soap="https://www.w3.org/2003/05/soapelope"
    xmlns:xml="https://www.w3.org/XML/1998/namespace"
    xmlns:wsa="https://schemas.xmlsoap.org/ws/2004/08/addressing"
    xmlns:nprt="https://schemas.microsoft.com/windows/2006/01/wdp/scan">
  <soap:Header>
    <wsa:Action>https://schemas.xmlsoap.org/ws/2004/08/addressing/fault</wsa:Action>
    <!-- Headers excluded for brevity -->
  </soap:Header>
  <soap:Body>
    <soap:Fault>
      <soap:Code>
        <soap:Value>env:Sender</soap:Value>
        <soap:Subcode>
          <soap:Value>wscn:OperationFailed</soap:Value>
        </soap:Subcode>
      </soap:Code>
      <soap:Reason>
        <soap:Text xml:lang="en">Service cannot perform the requested operation</soap:Text>
      </soap:Reason>
    </soap:Fault>
  </soap:Body>
</soap:Envelope>