Swift

Royal Mail OBA Web Service -- Get Contracts

See more Royal Mail OBA Examples

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

func chilkatTest() {
    var success: Bool = false

    // 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>

    let xml = CkoXml()!
    xml.emitXmlDecl = false
    xml.tag = "soapenv:Envelope"
    xml.addAttribute(name: "xmlns:soapenv", value: "http://schemas.xmlsoap.org/soap/envelope/")
    xml.addAttribute(name: "xmlns:epro", value: "urn:schemas-royalmail-com/webservice/epro")

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

    // Literally use the string "mysecuritytoken" here.
    xml.updateChildContent(tagPath: "soapenv:Header|epro:Authentication|epro:SecurityToken", value: "mysecuritytoken")
    xml.updateChildContent(tagPath: "soapenv:Body|epro:GetContracts|epro:Account", value: "account_number")

    let http = CkoHttp()!

    http.setRequestHeader(name: "SOAPAction", value: "urn:schemas-royalmail-com/webservice/epro/GetContracts")

    // 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
    var endpointUrl: String? = "http://interfaces.oba-v.royalmail.com/legacyws/EProImport.asmx"

    let resp = CkoHttpResponse()!
    success = http.httpStr(verb: "POST", url: endpointUrl, bodyStr: xml.getXml(), charset: "utf-8", contentType: "text/xml", response: resp)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("response status code = \(resp.statusCode.intValue)")
    print("\(resp.bodyStr!)")

    // 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>

    // 

    xml.load(xmlData: resp.bodyStr)

    var serviceName: String?
    var serviceReg: String?
    var serviceLevel: String?
    var contract: String?

    var i: Int = 0
    var numContracts: Int = xml.numChildrenHavingTag(tag: "SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails").intValue
    while i < numContracts {
        xml.i = i
        serviceName = xml.chilkatPath(cmd: "SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceName)")
        serviceReg = xml.chilkatPath(cmd: "SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceReg)")
        serviceLevel = xml.chilkatPath(cmd: "SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceLevel)")
        contract = xml.chilkatPath(cmd: "SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(Contract)")
        print("\(serviceName!)")
        i = i + 1
    }


}