Lua

Royal Mail OBA Web Service -- Get Contracts

See more Royal Mail OBA Examples

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

local chilkat = require("chilkat")

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

local xml = chilkat.Xml.new()
xml.emit_xml_decl = false
xml.tag = "soapenv:Envelope"
xml:add_attribute("xmlns:soapenv", "http://schemas.xmlsoap.org/soap/envelope/")
xml:add_attribute("xmlns:epro", "urn:schemas-royalmail-com/webservice/epro")

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

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

local http = chilkat.Http.new()

http:set_request_header("SOAPAction", "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
local endpointUrl = "http://interfaces.oba-v.royalmail.com/legacyws/EProImport.asmx"

local resp = chilkat.HttpResponse.new()
local success = http:http_str("POST", endpointUrl, xml:get_xml(), "utf-8", "text/xml", resp)
if not success then
    print(http.last_error_text)
    return
end

print("response status code = " .. resp.status_code)
print(resp.body_str)

-- 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_xml(resp.body_str)

local serviceName = ""
local serviceReg = ""
local serviceLevel = ""
local contract = ""

local i = 0
local numContracts = xml:num_children_having_tag("SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails")
while i < numContracts do
    xml.i = i
    serviceName = xml:chilkat_path("SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceName)")
    serviceReg = xml:chilkat_path("SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceReg)")
    serviceLevel = xml:chilkat_path("SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceLevel)")
    contract = xml:chilkat_path("SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(Contract)")
    print(serviceName)
    i = i + 1
end