(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set xml [new_CkXml]

CkXml_put_EmitXmlDecl $xml 0
CkXml_put_Tag $xml "soapenv:Envelope"
CkXml_AddAttribute $xml "xmlns:soapenv" "http://schemas.xmlsoap.org/soap/envelope/"
CkXml_AddAttribute $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_UpdateChildContent $xml "soapenv:Header|epro:Authentication|epro:Username" "my_username"
CkXml_UpdateChildContent $xml "soapenv:Header|epro:Authentication|epro:Password" "my_password"
CkXml_UpdateChildContent $xml "soapenv:Header|epro:Authentication|epro:AccessCode" "my_accessCode"
CkXml_UpdateChildContent $xml "soapenv:Header|epro:Authentication|epro:Version" "1.0"

# Literally use the string "mysecuritytoken" here.
CkXml_UpdateChildContent $xml "soapenv:Header|epro:Authentication|epro:SecurityToken" "mysecuritytoken"
CkXml_UpdateChildContent $xml "soapenv:Body|epro:GetContracts|epro:Account" "account_number"

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "SOAPAction" "urn:schemas-royalmail-com/webservice/epro/GetContracts"
CkHttp_SetRequestHeader $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
set endpointUrl "http://interfaces.oba-v.royalmail.com/legacyws/EProImport.asmx"

# resp is a CkHttpResponse
set resp [CkHttp_PostXml $http $endpointUrl [CkXml_getXml $xml] "utf-8"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkXml $xml
    delete_CkHttp $http
    exit
}

puts "response status code = [CkHttpResponse_get_StatusCode $resp]"
puts [CkHttpResponse_bodyStr $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_LoadXml $xml [CkHttpResponse_bodyStr $resp]

set i 0
set numContracts [CkXml_NumChildrenHavingTag $xml "SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails"]
while {$i < $numContracts} {
    CkXml_put_I $xml $i
    set serviceName [CkXml_chilkatPath $xml "SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceName)"]
    set serviceReg [CkXml_chilkatPath $xml "SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceReg)"]
    set serviceLevel [CkXml_chilkatPath $xml "SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceLevel)"]
    set contract [CkXml_chilkatPath $xml "SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(Contract)"]
    puts "$serviceName"
    set i [expr $i + 1]
}

delete_CkHttpResponse $resp


delete_CkXml $xml
delete_CkHttp $http