To Display a Typed Fault

In this procedure, you make the ListInventory operation display the typed fault. For the tshirt2.wsdl file, there is just one typed fault named TshirtFault, which is mapped to every operation that the WSDL has: OrderTshirt, ListInventory, and TrackOrder.

APIkit for SOAP supports the following types of SOAP faults:

  • Soap Fault 1.1

  • Soap Fault 1.2

You can select either type using any WSDL file, even for those files that do not contain typed faults.

  1. In Studio, search for fault in the palette.

    Multiple SOAP Fault components might appear.

  2. Drag and drop the SOAP Fault component into the ListInventory:api-config flow to the right of Transform.

    If the Operation Unavailable message appears telling you about a version discrepancy, cancel the operation, and choose another SOAP Fault component. Repeat these steps until you find a version match.

  3. In the properties editor, in Module Configuration, select soapkit-config from the drop-down.

  4. In Operation, select ListInventory from the drop-down.

  5. In Fault, select Fault from the drop-down and save the properties

  6. Click the Transform Message component to the left of the SOAP Fault component.

  7. Modify the DataWeave code as follows:

    %dw 2.0
    output application/xml
    ns ns0 http://mulesoft.org/tshirt-service
    ns soap http://schemas.xmlsoap.org/soap/envelope/
      soap#Fault: {
        faultcode: "soap:Server",
        faultstring: "The error details",
        detail: {
          ns0#TshirtFault: {
            errorStuff: 500
  8. Save and rerun the project.

    Using the SoapUI client, run the ListInventory operation.

    The client returns the following envelope instead of the default fault:

    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
             <faultstring>The error details</faultstring>
                <ns0:TshirtFault xmlns:ns0="http://mulesoft.org/tshirt-service">

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub