AwdbWebServiceSoapBinding / runDiagnostics

ASP AutoIt C C (Unicode) C++ C++ (Unicode) C# DataFlex Delphi Foxpro Go Java Node.js Objective-C Perl PHP Extension PowerBuilder Powershell PureBasic Python CkPython Ruby SQL Server Swift TCL VB.NET VB6 VBScript Xojo

IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkXml.pb"

Procedure ChilkatExample()

    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::setCkTag(xml, "soapenv:Envelope")
    CkXml::ckAddAttribute(xml,"xmlns:awd","http://www.wcc.nrcs.usda.gov/ns/awdbWebService")
    CkXml::ckAddAttribute(xml,"xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
    CkXml::ckUpdateChildContent(xml,"soapenv:Header","")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|awd:runDiagnostics","")

    ; In a SOAP HTTP request, including the XML declaration (<?xml version="1.0" encoding="UTF-8"?>) in the XML body is generally not required. 
    CkXml::setCkEmitXmlDecl(xml, 0)
    soapRequestBody.s = CkXml::ckGetXml(xml)

    endpoint.s = "https://wcc.sc.egov.usda.gov/awdbWebService/services"
    soapAction.s = ""
    ;  For SOAP requests, the standard Content-Type is usually set to "text/xml" or "application/soap+xml"
    contentType.s = "text/xml"

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttp::ckClearHeaders(http)
    CkHttp::ckSetRequestHeader(http,"Content-Type",contentType)
    CkHttp::ckSetRequestHeader(http,"SOAPAction",soapAction)

    resp.i = CkHttp::ckPostXml(http,endpoint,soapRequestBody,"utf-8")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        Debug "Failed to send SOAP request."
        CkXml::ckDispose(xml)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    ; Get the XML response body.
    responseXml.i = CkXml::ckCreate()
    If responseXml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodyXml(resp,responseXml)

    statusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "response status code: " + Str(statusCode)

    CkHttpResponse::ckDispose(resp)

    ; If the status code does not indicate succcess, then show the response XML,
    ; which probably contains error information.
    If statusCode <> 200
        Debug CkXml::ckGetXml(responseXml)
        CkXml::ckDispose(xml)
        CkHttp::ckDispose(http)
        CkXml::ckDispose(responseXml)
        ProcedureReturn
    EndIf

    Debug CkXml::ckGetXml(responseXml)

    ; Parse the successful SOAP response XML.

    ; This is a sample of the response XML, but the namespace prefixes will be different.
    ; We can parse the result using "*" for the namespace prefixes (see below).

    hasSucceeded.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:runDiagnosticsResponse|*:return|*:hasSucceeded")
    applicationBuildDate.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:runDiagnosticsResponse|*:return|*:testResults|*:applicationBuildDate")
    applicationVersion.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:runDiagnosticsResponse|*:return|*:testResults|*:applicationVersion")
    errorMessage.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:runDiagnosticsResponse|*:return|*:testResults|*:errorMessage")
    exceptionClass.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:runDiagnosticsResponse|*:return|*:testResults|*:exception|*:exceptionClass")
    message.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:runDiagnosticsResponse|*:return|*:testResults|*:exception|*:message")
    className.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:runDiagnosticsResponse|*:return|*:testResults|*:exception|*:strackTrace|*:className")
    fileName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:runDiagnosticsResponse|*:return|*:testResults|*:exception|*:strackTrace|*:fileName")
    lineNumber.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:runDiagnosticsResponse|*:return|*:testResults|*:exception|*:strackTrace|*:lineNumber")
    methodName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:runDiagnosticsResponse|*:return|*:testResults|*:exception|*:strackTrace|*:methodName")
    hasSucceeded = CkXml::ckGetChildContent(responseXml,"*:Body|*:runDiagnosticsResponse|*:return|*:testResults|*:hasSucceeded")
    testDescription.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:runDiagnosticsResponse|*:return|*:testResults|*:testDescription")


    CkXml::ckDispose(xml)
    CkHttp::ckDispose(http)
    CkXml::ckDispose(responseXml)


    ProcedureReturn
EndProcedure

Request XML

<soapenv:Envelope xmlns:awd="http://www.wcc.nrcs.usda.gov/ns/awdbWebService" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Header/>
    <soapenv:Body>
        <awd:runDiagnostics/>
    </soapenv:Body>
</soapenv:Envelope>

Response XML

<soapenv:Envelope xmlns:awd="http://www.wcc.nrcs.usda.gov/ns/awdbWebService" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Header/>
    <soapenv:Body>
        <awd:runDiagnosticsResponse>
            <awd:return>
                <awd:hasSucceeded>true</awd:hasSucceeded>
                <awd:testResults>
                    <awd:applicationBuildDate>string</awd:applicationBuildDate>
                    <awd:applicationVersion>string</awd:applicationVersion>
                    <awd:errorMessage>string</awd:errorMessage>
                    <awd:exception>
                        <awd:cause/>
                        <awd:exceptionClass>string</awd:exceptionClass>
                        <awd:message>string</awd:message>
                        <awd:strackTrace>
                            <awd:className>string</awd:className>
                            <awd:fileName>string</awd:fileName>
                            <awd:lineNumber>1042</awd:lineNumber>
                            <awd:methodName>string</awd:methodName>
                        </awd:strackTrace>
                    </awd:exception>
                    <awd:hasSucceeded>true</awd:hasSucceeded>
                    <awd:testDescription>string</awd:testDescription>
                </awd:testResults>
            </awd:return>
        </awd:runDiagnosticsResponse>
    </soapenv:Body>
</soapenv:Envelope>