Chilkat Tools

EProImportServiceSoap / BulkImportMailingItem

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:sch","urn:schemas-royalmail-com/webservice/epro")
    CkXml::ckUpdateChildContent(xml,"soapenv:Header|sch:Authentication|sch:Username","string")
    CkXml::ckUpdateChildContent(xml,"soapenv:Header|sch:Authentication|sch:Password","string")
    CkXml::ckUpdateChildContentInt(xml,"soapenv:Header|sch:Authentication|sch:AccessCode",1042)
    CkXml::ckUpdateChildContent(xml,"soapenv:Header|sch:Authentication|sch:Version","string")
    CkXml::ckUpdateChildContent(xml,"soapenv:Header|sch:Authentication|sch:SecurityToken","string")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|sch:BulkImportMailingItem|sch:EproCode|sch:string","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 = "http://www.epro.royalmail.com/WebServices/import/eproimport.asmx"
    soapAction.s = "urn:schemas-royalmail-com/webservice/epro/BulkImportMailingItem"
    ;  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).

    BulkImportMailingItemResult_MachineName.s = CkXml::ckChilkatPath(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|(MachineName)")
    BulkImportMailingItemResult_StartTime.s = CkXml::ckChilkatPath(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|(StartTime)")
    BulkImportMailingItemResult_EndTime.s = CkXml::ckChilkatPath(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|(EndTime)")
    BulkImportMailingItemResult_Version.s = CkXml::ckChilkatPath(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|(Version)")
    BulkImportMailingItemResult_TransactionID.s = CkXml::ckChilkatPath(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|(TransactionID)")
    BulkImportMailingItemResult_DocketsCreated.s = CkXml::ckChilkatPath(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|(DocketsCreated)")
    BulkImportMailingItemResult_ErrorEncountered.s = CkXml::ckChilkatPath(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|(ErrorEncountered)")
    BulkImportMailingItemResult_DateTime.s = CkXml::ckChilkatPath(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|(DateTime)")
    BulkImportMailingItemResult_RecordCount.s = CkXml::ckChilkatPath(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|(RecordCount)")
    BulkImportMailingItemResult_RecordsImported.s = CkXml::ckChilkatPath(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|(RecordsImported)")
    BulkImportMailingItemResult_RecordsRejected.s = CkXml::ckChilkatPath(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|(RecordsRejected)")
    BulkImportMailingItemResult_TransactionDeleted.s = CkXml::ckChilkatPath(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|(TransactionDeleted)")
    BulkImportMailingItemResult_User.s = CkXml::ckChilkatPath(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|(User)")
    DocketNumber.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|*:Dockets|*:Docket|*:DocketNumber")
    Message.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|*:Errors|*:Error|*:Message")
    ExtraInformation.s = CkXml::ckGetChildContent(responseXml,"*:Body|*:BulkImportMailingItemResponse|*:BulkImportMailingItemResult|*:Errors|*:Error|*:ExtraInformation")


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


    ProcedureReturn
EndProcedure

Request XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="urn:schemas-royalmail-com/webservice/epro">
    <soapenv:Header>
        <sch:Authentication>
            <sch:Username>string</sch:Username>
            <sch:Password>string</sch:Password>
            <sch:AccessCode>1042</sch:AccessCode>
            <sch:Version>string</sch:Version>
            <sch:SecurityToken>string</sch:SecurityToken>
        </sch:Authentication>
    </soapenv:Header>
    <soapenv:Body>
        <sch:BulkImportMailingItem>
            <sch:EproCode>
                <sch:string>string</sch:string>
            </sch:EproCode>
        </sch:BulkImportMailingItem>
    </soapenv:Body>
</soapenv:Envelope>

Response XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="urn:schemas-royalmail-com/webservice/epro">
    <soapenv:Header/>
    <soapenv:Body>
        <sch:BulkImportMailingItemResponse>
            <sch:BulkImportMailingItemResult MachineName="?" StartTime="?" EndTime="?" Version="?" TransactionID="?" DocketsCreated="?" ErrorEncountered="?" DateTime="?" RecordCount="?" RecordsImported="?" RecordsRejected="?" TransactionDeleted="?" User="?">
                <sch:Dockets>
                    <sch:Docket>
                        <sch:DocketNumber>string</sch:DocketNumber>
                    </sch:Docket>
                </sch:Dockets>
                <sch:Errors>
                    <sch:Error>
                        <sch:Message>string</sch:Message>
                        <sch:ExtraInformation>string</sch:ExtraInformation>
                    </sch:Error>
                </sch:Errors>
            </sch:BulkImportMailingItemResult>
        </sch:BulkImportMailingItemResponse>
    </soapenv:Body>
</soapenv:Envelope>

SOAP WSDL Generate Code

EProImportServiceSoap / BulkImportMailingItem

Request XML

Response XML