Node.js

Royal Mail OBA Web Service -- Get Contracts

See more Royal Mail OBA Examples

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

NODEJS_PRELUDE

function chilkatExample() {

    var success = 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>

    var xml = new chilkat.Xml();
    xml.EmitXmlDecl = false;
    xml.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");

    var http = new chilkat.Http();

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

    var resp = new chilkat.HttpResponse();
    success = http.HttpStr("POST",endpointUrl,xml.GetXml(),"utf-8","text/xml",resp);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log("response status code = " + resp.StatusCode);
    console.log(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.LoadXml(resp.BodyStr);

    var serviceName;
    var serviceReg;
    var serviceLevel;
    var contract;

    var i = 0;
    var numContracts = xml.NumChildrenHavingTag("SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails");
    while (i < numContracts) {
        xml.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)");
        console.log(serviceName);
        i = i+1;
    }


}

chilkatExample();