AwdbWebServiceSoapBinding / getForecast

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:getForecast|awd:stationTriplet","string")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|awd:getForecast|awd:elementCd","string")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|awd:getForecast|awd:forecastPeriod","string")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|awd:getForecast|awd:publicationDate","string")

    ; 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).

    calculationDate.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:getForecastResponse|*:return|*:calculationDate")
    elementCd.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:getForecastResponse|*:return|*:elementCd")
    exceedenceProbabilities.i = CkXml::ckGetChildIntValue(responseXml,"*:Body|*:getForecastResponse|*:return|*:exceedenceProbabilities")
    exceedenceValues.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:getForecastResponse|*:return|*:exceedenceValues")
    forecastPeriod.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:getForecastResponse|*:return|*:forecastPeriod")
    periodAverage.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:getForecastResponse|*:return|*:periodAverage")
    publicationDate.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:getForecastResponse|*:return|*:publicationDate")
    stationTriplet.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:getForecastResponse|*:return|*:stationTriplet")
    unitCd.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:getForecastResponse|*:return|*:unitCd")


    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:getForecast>
            <awd:stationTriplet>string</awd:stationTriplet>
            <awd:elementCd>string</awd:elementCd>
            <awd:forecastPeriod>string</awd:forecastPeriod>
            <awd:publicationDate>string</awd:publicationDate>
        </awd:getForecast>
    </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:getForecastResponse>
            <awd:return>
                <awd:calculationDate>string</awd:calculationDate>
                <awd:elementCd>string</awd:elementCd>
                <awd:exceedenceProbabilities>1042</awd:exceedenceProbabilities>
                <awd:exceedenceValues>99.0</awd:exceedenceValues>
                <awd:forecastPeriod>string</awd:forecastPeriod>
                <awd:periodAverage>99.0</awd:periodAverage>
                <awd:publicationDate>string</awd:publicationDate>
                <awd:stationTriplet>string</awd:stationTriplet>
                <awd:unitCd>string</awd:unitCd>
            </awd:return>
        </awd:getForecastResponse>
    </soapenv:Body>
</soapenv:Envelope>