Removing unnecessary extra characters from both the beginning and end of a SOAP response when using PHP SoapClient

Question

Removing unnecessary extra characters from both the beginning and end of a SOAP response when using PHP SoapClient

When I attempted to retrieve data from a SOAP API server using PHP, I encountered an issue with the response code. The code "looks like we got no XML document" was returned.

try {
    $soap = new SoapClient($wsdl, $options);
    $data = $soap->GetXYZ($params);
}
catch(Exception $e) {
    $Lastresponse = $soap->__getLastResponse();
}

Upon inspecting the $Lastresponse variable in the catch block, I found it contained additional information:

------=_Part_1134075_393252946.1482317378966 Content-Type: application/xop+xml; charset=utf-8; type="text/xml" <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> ......all valid data ... </SOAP-ENV:Body> </SOAP-ENV:Envelope> ------=_Part_1134075_393252946.1482317378966--

Note: The $options array I am using includes parameters such as 'uri', 'soap_version', 'cache_wsdl', and more to define the SOAP settings.

Although I managed to handle the XML parsing workaround, I'm curious about the extra -----Part bits in the response. Any insights on what might be causing this or if there's a mistake in my setup?

php xml web-services soap

Answer 1

Answer №1

Those specific markers known as the boundary in multipart messages are described in detail here and defined in RFC2387.

Upon investigation, it appears that SoapClient lacks the ability to interpret multipart messages, leading to the exception you encountered.

The workaround involves extending SoapClient to extract the XML content using regex or other string methods. Here is a sample approach found on this page:

class MySoapClient extends SoapClient {
    public function __doRequest($request, $location, $action, $version, $one_way = 0) { 
        $response = parent::__doRequest($request, $location, $action, $version, $one_way);
        $start = strpos($response,'<?xml'); 
        $end = strrpos($response,'>'); 
        return substr($response,$start,$end-$start+1);
    }
}

Answer 2

Those specific markers known as the boundary in multipart messages are described in detail here and defined in RFC2387.

Upon investigation, it appears that SoapClient lacks the ability to interpret multipart messages, leading to the exception you encountered.

The workaround involves extending SoapClient to extract the XML content using regex or other string methods. Here is a sample approach found on this page:

class MySoapClient extends SoapClient {
    public function __doRequest($request, $location, $action, $version, $one_way = 0) { 
        $response = parent::__doRequest($request, $location, $action, $version, $one_way);
        $start = strpos($response,'<?xml'); 
        $end = strrpos($response,'>'); 
        return substr($response,$start,$end-$start+1);
    }
}

Answer 3

Answer №2

Kindly test the query below and share your feedback:


$headers = array(
    "POST: ".url." HTTP/1.1",
    "Host: ".domain."",
    "Accept-Encoding: gzip,deflate",
    "Content-type: text/xml;charset=UTF-8",
    "SOAPAction: \"http://tempuri.org/wsdlurl/methodname\"",
    "Connection: Keep-Alive",
    "Content-length:".strlen($xml),
    "User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
    "
)

$url = your url;
$ch = curl_init();      
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_ENCODING, '');
curl_setopt($ch, CURLOPT_POSTFIELDS, $options); // the SOAP request
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);     
$response = curl_exec($ch);
$err = curl_error($ch);
$doc = new DOMDocument();
$doc->loadXML( $response );     
$authKey = $doc->getElementsByTagName( "fieldname" );

Answer 4

Kindly test the query below and share your feedback:


$headers = array(
    "POST: ".url." HTTP/1.1",
    "Host: ".domain."",
    "Accept-Encoding: gzip,deflate",
    "Content-type: text/xml;charset=UTF-8",
    "SOAPAction: \"http://tempuri.org/wsdlurl/methodname\"",
    "Connection: Keep-Alive",
    "Content-length:".strlen($xml),
    "User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
    "
)

$url = your url;
$ch = curl_init();      
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_ENCODING, '');
curl_setopt($ch, CURLOPT_POSTFIELDS, $options); // the SOAP request
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);     
$response = curl_exec($ch);
$err = curl_error($ch);
$doc = new DOMDocument();
$doc->loadXML( $response );     
$authKey = $doc->getElementsByTagName( "fieldname" );

Answer 5

Answer №3

Make sure to handle Exceptions:

When using SoapClient in non-WSDL mode, not providing the location and uri options will result in an E_ERROR error being generated.

If the wsdl URI cannot be loaded, a SoapFault exception will be thrown.

Answer 6

Make sure to handle Exceptions:

When using SoapClient in non-WSDL mode, not providing the location and uri options will result in an E_ERROR error being generated.

If the wsdl URI cannot be loaded, a SoapFault exception will be thrown.

Removing unnecessary extra characters from both the beginning and end of a SOAP response when using PHP SoapClient

Answer №1

Answer №2

Answer №3

Similar questions

Storing data with Laravel 5.3 using Storage::put and XMLHttpRequest

Incorporate Live Data into Google Charts Using Ajax Response for a Dynamic Visualization

How to drop several pins on Google Maps with JavaScript

Deleting an element from HTML using jQuery

JavaScript doesn't automatically redirect after receiving a response

Mastering Yii2: Implementing Javascript Functions such as onchange() in a View

Jquery Triggers Failing to Work Following Ajax Request

Utilizing JSON for Google Charts

"Make sure to specify Safari input field as an email and mark

Utilizing Bootstrap Modal to Display PHP Data Dynamically

Warning displayed on form input still allows submission

Issues with sending an AJAX POST request to a PHP script

Guide on automatically attaching a file to an input file type field from a database

Is there a way to retrieve a single value using AJAX instead of returning the entire HTML page?

Transmit a data point from JavaScript to PHP

Executing JavaScript function by clicking on <img>

Using jQuery to dynamically insert a table row with JSON data into dropdown menus

Accessing form data from Ajax/Jquery in php using $_POST variables

Unexpected error 500 (Internal Server Error) occurred due to BadMethodCallException

Eliminate duplicate time slots in Laravel and Vuejs