(Perl) 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 Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

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

$xml = chilkat::CkXml->new();
$xml->put_EmitXmlDecl(0);
$xml->put_Tag("soapenv:Envelope");
$xml->AddAttribute("xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/");
$xml->AddAttribute("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->UpdateChildContent("soapenv:Header|epro:Authentication|epro:Username","my_username");
$xml->UpdateChildContent("soapenv:Header|epro:Authentication|epro:Password","my_password");
$xml->UpdateChildContent("soapenv:Header|epro:Authentication|epro:AccessCode","my_accessCode");
$xml->UpdateChildContent("soapenv:Header|epro:Authentication|epro:Version","1.0");

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

$http = chilkat::CkHttp->new();

$http->SetRequestHeader("SOAPAction","urn:schemas-royalmail-com/webservice/epro/GetContracts");
$http->SetRequestHeader("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 = "http://interfaces.oba-v.royalmail.com/legacyws/EProImport.asmx";

# resp is a HttpResponse
$resp = $http->PostXml($endpointUrl,$xml->getXml(),"utf-8");
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

print "response status code = " . $resp->get_StatusCode() . "\r\n";
print $resp->bodyStr() . "\r\n";

# 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->LoadXml($resp->bodyStr());

$i = 0;
$numContracts = $xml->NumChildrenHavingTag("SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails");
while ($i < $numContracts) {
    $xml->put_I($i);
    $serviceName = $xml->chilkatPath("SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceName)");
    $serviceReg = $xml->chilkatPath("SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceReg)");
    $serviceLevel = $xml->chilkatPath("SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceLevel)");
    $contract = $xml->chilkatPath("SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(Contract)");
    print $serviceName . "\r\n";
    $i = $i + 1;
}