(SQL Server) SOAP Web Service (HTTP POST)

Demonstrates how to call PostXml to call a SOAP web service.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    -- --------------------------------------------------------------------------------
    -- Also see Chilkat's Online WSDL Code Generator
    -- to generate code and SOAP Request and Response XML for each operation in a WSDL.
    -- --------------------------------------------------------------------------------

    -- This example uses a live web service at:
    -- http://www.webservicex.net/uklocation.asmx
    -- It gets the UK town,Postcode and County by Postcode(First Section of Post Code)

    -- The SOAP XML will look like this:
    -- <?xml version="1.0" encoding="utf-8"?>
    -- <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    --   <soap:Body>
    --     <GetUKLocationByPostCode xmlns="http://www.webserviceX.NET">
    --       <PostCode>string</PostCode>
    --     </GetUKLocationByPostCode>
    --   </soap:Body>
    -- </soap:Envelope>

    -- For this example's sake, we'll load the XML from a file.  We'll test using PostCode "E3".  
    -- The SOAP XML for this example may be downloaded from:
    -- http://www.chilkatsoft.com/testData/ukPostCodeSoap.xml
    DECLARE @xml int
    -- Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Xml', @xml OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int
    EXEC sp_OAMethod @xml, 'LoadXmlFile', @success OUT, 'ukPostCodeSoap.xml'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @xml, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @xml
        RETURN
      END

    DECLARE @strXml nvarchar(4000)
    EXEC sp_OAMethod @xml, 'GetXml', @strXml OUT

    DECLARE @responseStatusCode int

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT

    -- We'll need to add this in the HTTP header:
    -- SOAPAction: "http://www.webserviceX.NET/GetUKLocationByPostCode"
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'SOAPAction', 'http://www.webserviceX.NET/GetUKLocationByPostCode'

    -- Some services expect the content-type in the HTTP header to be "application/xml" while
    -- other expect text/xml.  The default sent by Chilkat is "application/xml", but this web service
    -- expects "text/xml".  Therefore, change the content-type:
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'text/xml; charset=utf-8'

    -- The endpoint for this soap service is:
    DECLARE @endPoint nvarchar(4000)
    SELECT @endPoint = 'http://www.webservicex.net/uklocation.asmx'

    -- Note: This particular web service was live and functioning at the time this example
    -- was written.  It is possible that as time progresses, this web service will no longer
    -- be availble...
    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostXml', @resp OUT, @endPoint, @strXml, 'utf-8'
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'LastHeader:'
        EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @xml
        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @responseStatusCode OUT
    -- You may wish to verify that the responseStatusCode equals 200...

    PRINT 'Response Status Code: ' + @responseStatusCode

    -- You may examine the exact HTTP header sent with the POST like this:

    PRINT 'LastHeader:'
    EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
    PRINT @sTmp0

    -- Examine the XML returned by the web service:

    PRINT 'XML Response:'
    DECLARE @xmlResp int
    -- Use "Chilkat_9_5_0.Xml" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Xml', @xmlResp OUT

    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    EXEC sp_OAMethod @xmlResp, 'LoadXml', @success OUT, @sTmp0
    EXEC sp_OAMethod @xmlResp, 'GetXml', @sTmp0 OUT
    PRINT @sTmp0

    -- Use this online tool to generate parsing code from response XML: 
    -- Generate Parsing Code from XML

    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @xml
    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @xmlResp


END
GO