Chilkat Tools

SpringCMServiceSoap / ContactFind

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

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:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
    CkXml::ckAddAttribute(xml,"xmlns:spr","http://www.springcm.com/atlas/webservices/v201308/scm/")
    CkXml::ckUpdateChildContent(xml,"soapenv:Header","")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:ContactFind|spr:token","string")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:ContactFind|spr:SearchText","string")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|spr:ContactFind|spr:IncludeDeleted","true")

    ; 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://soapna11.springcm.com/atlas/webservices/v201308/springcmservice.asmx"
    soapAction.s = "http://www.springcm.com/atlas/webservices/v201308/scm/ContactFind"
    ;  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).

    Id.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:Id")
    Name.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:Name")
    ObjectType.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:ObjectType")
    v_Email.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:Email")
    FirstName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:FirstName")
    LastName.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:LastName")
    PhoneNumber.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:PhoneNumber")
    FaxNumber.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:FaxNumber")
    Company.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:Company")
    Department.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:Department")
    Title.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:Title")
    Address1.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:Address1")
    Address2.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:Address2")
    Address3.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:Address3")
    City.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:City")
    ProvinceState.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:ProvinceState")
    PostalCode.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:PostalCode")
    Country.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:ContactFindResponse|*:ContactFindResult|*:SCMContactInfo|*:Country")


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


    ProcedureReturn
EndProcedure

Request XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:spr="http://www.springcm.com/atlas/webservices/v201308/scm/">
    <soapenv:Header/>
    <soapenv:Body>
        <spr:ContactFind>
            <spr:token>string</spr:token>
            <spr:SearchText>string</spr:SearchText>
            <spr:IncludeDeleted>true</spr:IncludeDeleted>
        </spr:ContactFind>
    </soapenv:Body>
</soapenv:Envelope>

Response XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:spr="http://www.springcm.com/atlas/webservices/v201308/scm/">
    <soapenv:Header/>
    <soapenv:Body>
        <spr:ContactFindResponse>
            <spr:ContactFindResult>
                <spr:SCMContactInfo>
                    <spr:Id>string</spr:Id>
                    <spr:Name>string</spr:Name>
                    <spr:ObjectType>Document</spr:ObjectType>
                    <spr:Email>string</spr:Email>
                    <spr:FirstName>string</spr:FirstName>
                    <spr:LastName>string</spr:LastName>
                    <spr:PhoneNumber>string</spr:PhoneNumber>
                    <spr:FaxNumber>string</spr:FaxNumber>
                    <spr:Company>string</spr:Company>
                    <spr:Department>string</spr:Department>
                    <spr:Title>string</spr:Title>
                    <spr:Address1>string</spr:Address1>
                    <spr:Address2>string</spr:Address2>
                    <spr:Address3>string</spr:Address3>
                    <spr:City>string</spr:City>
                    <spr:ProvinceState>string</spr:ProvinceState>
                    <spr:PostalCode>string</spr:PostalCode>
                    <spr:Country>string</spr:Country>
                </spr:SCMContactInfo>
            </spr:ContactFindResult>
        </spr:ContactFindResponse>
    </soapenv:Body>
</soapenv:Envelope>

SOAP WSDL Generate Code

SpringCMServiceSoap / ContactFind

Request XML

Response XML