Chilkat Tools

CAPSoapHttp / getMessage

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

Min Request Full Request

require 'chilkat'

xml = Chilkat::CkXml.new()
xml.put_Tag("soapenv:Envelope")
xml.AddAttribute("xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
xml.AddAttribute("xmlns:req","http://gov.fema.ipaws.services/caprequest")
xml.AddAttribute("xmlns:WL5G3N1","http://gov.fema.ipaws.services/IPAWS_CAPService/")
xml.AddAttribute("xmlns:capreq","http://gov.fema.ipaws.services/caprequest")
xml.UpdateChildContent("soapenv:Header|WL5G3N1:request_Header|WL5G3N1:logonUser","xml")
xml.UpdateChildContent("soapenv:Header|WL5G3N1:request_Header|WL5G3N1:logonCogId","xml")
xml.UpdateChildContent("soapenv:Body|WL5G3N1:getMessageTypeDef|req:requestAPI","string")
xml.UpdateChildContent("soapenv:Body|WL5G3N1:getMessageTypeDef|req:requestOperation","string")
xml.UpdateChildContent("soapenv:Body|WL5G3N1:getMessageTypeDef|req:parameters|req:parameterName","string")
xml.UpdateChildContent("soapenv:Body|WL5G3N1:getMessageTypeDef|req:parameters|req:comparisonOp","string")
xml.UpdateChildContent("soapenv:Body|WL5G3N1:getMessageTypeDef|req:parameters|req:parameterValue","string")
xml.UpdateChildContent("soapenv:Body|WL5G3N1:getMessageTypeDef|req:parameters|req:logicalOp","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. 
xml.put_EmitXmlDecl(false)
soapRequestBody = xml.getXml()

endpoint = "http://tdl.integration.aws.fema.gov/IPAWS_CAPService/IPAWS"
soapAction = "http://gov.fema.ipaws.services/IPAWS_CAPService/getMessage"
#  For SOAP requests, the standard Content-Type is usually set to "text/xml" or "application/soap+xml"
contentType = "text/xml"

http = Chilkat::CkHttp.new()

http.ClearHeaders()
http.SetRequestHeader("Content-Type",contentType)
http.SetRequestHeader("SOAPAction",soapAction)

# resp is a CkHttpResponse
resp = http.PostXml(endpoint,soapRequestBody,"utf-8")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    print "Failed to send SOAP request." + "\n";
    exit
end

# Get the XML response body.
responseXml = Chilkat::CkXml.new()
resp.GetBodyXml(responseXml)

statusCode = resp.get_StatusCode()
print "response status code: " + statusCode.to_s() + "\n";

# If the status code does not indicate succcess, then show the response XML,
# which probably contains error information.
if (statusCode != 200)
    print responseXml.getXml() + "\n";
    exit
end

print responseXml.getXml() + "\n";

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

identifier = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:identifier")
sender = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:sender")
sent = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:sent")
status = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:status")
msgType = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:msgType")
source = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:source")
scope = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:scope")
restriction = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:restriction")
addresses = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:addresses")
code = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:code")
note = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:note")
references = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:references")
incidents = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:incidents")
language = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:language")
category = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:category")
v_event = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:event")
responseType = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:responseType")
urgency = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:urgency")
severity = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:severity")
certainty = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:certainty")
audience = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:audience")
valueName = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:eventCode|*:valueName")
value = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:eventCode|*:value")
effective = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:effective")
onset = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:onset")
expires = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:expires")
senderName = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:senderName")
headline = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:headline")
description = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:description")
instruction = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:instruction")
web = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:web")
contact = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:contact")
valueName = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:parameter|*:valueName")
value = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:parameter|*:value")
resourceDesc = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:resource|*:resourceDesc")
mimeType = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:resource|*:mimeType")
size = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:resource|*:size")
uri = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:resource|*:uri")
derefUri = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:resource|*:derefUri")
digest = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:resource|*:digest")
areaDesc = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:area|*:areaDesc")
polygon = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:area|*:polygon")
circle = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:area|*:circle")
valueName = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:area|*:geocode|*:valueName")
value = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:area|*:geocode|*:value")
altitude = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:area|*:altitude")
ceiling = responseXml.getChildContent("*:Body|*:messageResponseTypeDef|*:alert|*:info|*:area|*:ceiling")

Request XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:req="http://gov.fema.ipaws.services/caprequest" xmlns:WL5G3N1="http://gov.fema.ipaws.services/IPAWS_CAPService/" xmlns:capreq="http://gov.fema.ipaws.services/caprequest">
    <soapenv:Header>
        <WL5G3N1:request_Header>
            <WL5G3N1:logonUser>xml</WL5G3N1:logonUser>
            <WL5G3N1:logonCogId>xml</WL5G3N1:logonCogId>
        </WL5G3N1:request_Header>
    </soapenv:Header>
    <soapenv:Body>
        <WL5G3N1:getMessageTypeDef>
            <req:requestAPI>string</req:requestAPI>
            <req:requestOperation>string</req:requestOperation>
            <req:parameters>
                <req:parameterName>string</req:parameterName>
                <req:comparisonOp>string</req:comparisonOp>
                <req:parameterValue>string</req:parameterValue>
                <req:logicalOp>string</req:logicalOp>
            </req:parameters>
        </WL5G3N1:getMessageTypeDef>
    </soapenv:Body>
</soapenv:Envelope>

Response XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:WL5G3N1="http://gov.fema.ipaws.services/IPAWS_CAPService/" xmlns:cap="urn:oasis:names:tc:emergency:cap:1.2">
    <soapenv:Header/>
    <soapenv:Body>
        <WL5G3N1:messageResponseTypeDef>
            <cap:alert>
                <cap:identifier>xml</cap:identifier>
                <cap:sender>xml</cap:sender>
                <cap:sent>dateTime</cap:sent>
                <cap:status>Actual</cap:status>
                <cap:msgType>Alert</cap:msgType>
                <cap:source>xml</cap:source>
                <cap:scope>Public</cap:scope>
                <cap:restriction>xml</cap:restriction>
                <cap:addresses>xml</cap:addresses>
                <cap:code>xml</cap:code>
                <cap:note>xml</cap:note>
                <cap:references>xml</cap:references>
                <cap:incidents>xml</cap:incidents>
                <cap:info>
                    <cap:language>xml</cap:language>
                    <cap:category>Geo</cap:category>
                    <cap:event>xml</cap:event>
                    <cap:responseType>Shelter</cap:responseType>
                    <cap:urgency>Immediate</cap:urgency>
                    <cap:severity>Extreme</cap:severity>
                    <cap:certainty>Observed</cap:certainty>
                    <cap:audience>xml</cap:audience>
                    <cap:eventCode>
                        <cap:valueName>xml</cap:valueName>
                        <cap:value>xml</cap:value>
                    </cap:eventCode>
                    <cap:effective>dateTime</cap:effective>
                    <cap:onset>dateTime</cap:onset>
                    <cap:expires>dateTime</cap:expires>
                    <cap:senderName>xml</cap:senderName>
                    <cap:headline>xml</cap:headline>
                    <cap:description>xml</cap:description>
                    <cap:instruction>xml</cap:instruction>
                    <cap:web>xml</cap:web>
                    <cap:contact>xml</cap:contact>
                    <cap:parameter>
                        <cap:valueName>xml</cap:valueName>
                        <cap:value>xml</cap:value>
                    </cap:parameter>
                    <cap:resource>
                        <cap:resourceDesc>xml</cap:resourceDesc>
                        <cap:mimeType>xml</cap:mimeType>
                        <cap:size>xml</cap:size>
                        <cap:uri>xml</cap:uri>
                        <cap:derefUri>xml</cap:derefUri>
                        <cap:digest>xml</cap:digest>
                    </cap:resource>
                    <cap:area>
                        <cap:areaDesc>xml</cap:areaDesc>
                        <cap:polygon>xml</cap:polygon>
                        <cap:circle>xml</cap:circle>
                        <cap:geocode>
                            <cap:valueName>xml</cap:valueName>
                            <cap:value>xml</cap:value>
                        </cap:geocode>
                        <cap:altitude>xml</cap:altitude>
                        <cap:ceiling>xml</cap:ceiling>
                    </cap:area>
                </cap:info>
            </cap:alert>
        </WL5G3N1:messageResponseTypeDef>
    </soapenv:Body>
</soapenv:Envelope>

SOAP WSDL Generate Code

CAPSoapHttp / getMessage

Request XML

Response XML