(PureBasic) Royal Mail OBA Web Service -- Get Contracts

See more Royal Mail OBA Examples

Royal Mail OBA Web Service -- Get the contracts for an account.

For more information, see https://parcel.royalmail.com/eproimport.wsdl

Chilkat PureBasic Module Download Chilkat PureBasic Module

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

Procedure ChilkatExample()

    ; This example requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    ; Create the following XML:

    ; <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:epro="urn:schemas-royalmail-com/webservice/epro">
    ;    <soapenv:Header>
    ;       <epro:Authentication>
    ;          <epro:Username>my_username</epro:Username>
    ;          <epro:Password>my_password</epro:Password>
    ;          <epro:AccessCode>my_accessCode</epro:AccessCode>
    ;          <epro:Version>1.0</epro:Version>
    ;          <epro:SecurityToken>mysecuritytoken</epro:SecurityToken>
    ;       </epro:Authentication>
    ;    </soapenv:Header>
    ;    <soapenv:Body>
    ;       <epro:GetContracts>
    ;         <epro:Account>account_number</epro:Account>
    ;       </epro:GetContracts>
    ;    </soapenv:Body>
    ; </soapenv:Envelope>

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

    CkXml::setCkEmitXmlDecl(xml, 0)
    CkXml::setCkTag(xml, "soapenv:Envelope")
    CkXml::ckAddAttribute(xml,"xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
    CkXml::ckAddAttribute(xml,"xmlns:epro","urn:schemas-royalmail-com/webservice/epro")

    ; Replace my_username, my_password, and my_accessCode with your actual values.  Do not replace "mysecuritytoken".
    CkXml::ckUpdateChildContent(xml,"soapenv:Header|epro:Authentication|epro:Username","my_username")
    CkXml::ckUpdateChildContent(xml,"soapenv:Header|epro:Authentication|epro:Password","my_password")
    CkXml::ckUpdateChildContent(xml,"soapenv:Header|epro:Authentication|epro:AccessCode","my_accessCode")
    CkXml::ckUpdateChildContent(xml,"soapenv:Header|epro:Authentication|epro:Version","1.0")

    ; Literally use the string "mysecuritytoken" here.
    CkXml::ckUpdateChildContent(xml,"soapenv:Header|epro:Authentication|epro:SecurityToken","mysecuritytoken")
    CkXml::ckUpdateChildContent(xml,"soapenv:Body|epro:GetContracts|epro:Account","account_number")

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

    CkHttp::ckSetRequestHeader(http,"SOAPAction","urn:schemas-royalmail-com/webservice/epro/GetContracts")
    CkHttp::ckSetRequestHeader(http,"Content-Type","text/xml; charset=utf-8")

    ; Use the sandbox endpoint:   http://interfaces.oba-v.royalmail.com/legacyws/EProImport.asmx 
    ; The live endpoint would be: http://www.epro.royalmail.com/WebServices/import/eproimport.asmx
    endpointUrl.s = "http://interfaces.oba-v.royalmail.com/legacyws/EProImport.asmx"

    resp.i = CkHttp::ckPostXml(http,endpointUrl,CkXml::ckGetXml(xml),"utf-8")
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkXml::ckDispose(xml)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    Debug "response status code = " + Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)

    ; The response looks like this:

    ; <?xml version="1.0" encoding="utf-8"?>
    ; <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    ;     <SOAP-ENV:Header/>
    ;     <SOAP-ENV:Body>
    ;         <ns1:GetContractsResponse xmlns:ns1="urn:schemas-royalmail-com/webservice/epro">
    ;             <ns1:GetContractsResult Version="1">
    ;                 <ns1:Contracts>
    ;                     <ns1:ContractDetails ServiceName="ADV MAIL + RESPONSE UNSORTED 2C" ServiceReg="AC2" ServiceLevel="01" Contract="DEMOTEST1"/>
    ;                     <ns1:ContractDetails ServiceName="PLANNED ENVELOPE POLL CARD MMK-2C      " ServiceReg="AG0" ServiceLevel="01" Contract=""/>
    ; 			...
    ;                 </ns1:Contracts>
    ;             </ns1:GetContractsResult>
    ;         </ns1:GetContractsResponse>
    ;     </SOAP-ENV:Body>
    ; </SOAP-ENV:Envelope>

    ; 

    CkXml::ckLoadXml(xml,CkHttpResponse::ckBodyStr(resp))

    serviceName.s
    serviceReg.s
    serviceLevel.s
    contract.s

    i.i = 0
    numContracts.i = CkXml::ckNumChildrenHavingTag(xml,"SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails")
    While i < numContracts
        CkXml::setCkI(xml, i)
        serviceName = CkXml::ckChilkatPath(xml,"SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceName)")
        serviceReg = CkXml::ckChilkatPath(xml,"SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceReg)")
        serviceLevel = CkXml::ckChilkatPath(xml,"SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceLevel)")
        contract = CkXml::ckChilkatPath(xml,"SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(Contract)")
        Debug serviceName
        i = i + 1
    Wend

    CkHttpResponse::ckDispose(resp)



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


    ProcedureReturn
EndProcedure