(Objective-C) 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 Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoXml.h>
#import <CkoHttp.h>
#import <NSString.h>
#import <CkoHttpResponse.h>

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

CkoXml *xml = [[CkoXml alloc] init];
xml.EmitXmlDecl = NO;
xml.Tag = @"soapenv:Envelope";
[xml AddAttribute: @"xmlns:soapenv" value: @"http://schemas.xmlsoap.org/soap/envelope/"];
[xml AddAttribute: @"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: @"soapenv:Header|epro:Authentication|epro:Username" value: @"my_username"];
[xml UpdateChildContent: @"soapenv:Header|epro:Authentication|epro:Password" value: @"my_password"];
[xml UpdateChildContent: @"soapenv:Header|epro:Authentication|epro:AccessCode" value: @"my_accessCode"];
[xml UpdateChildContent: @"soapenv:Header|epro:Authentication|epro:Version" value: @"1.0"];

// Literally use the string "mysecuritytoken" here.
[xml UpdateChildContent: @"soapenv:Header|epro:Authentication|epro:SecurityToken" value: @"mysecuritytoken"];
[xml UpdateChildContent: @"soapenv:Body|epro:GetContracts|epro:Account" value: @"account_number"];

CkoHttp *http = [[CkoHttp alloc] init];

[http SetRequestHeader: @"SOAPAction" value: @"urn:schemas-royalmail-com/webservice/epro/GetContracts"];
[http SetRequestHeader: @"Content-Type" value: @"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
NSString *endpointUrl = @"http://interfaces.oba-v.royalmail.com/legacyws/EProImport.asmx";

CkoHttpResponse *resp = [http PostXml: endpointUrl xmlDoc: [xml GetXml] charset: @"utf-8"];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%@%d",@"response status code = ",[resp.StatusCode intValue]);
NSLog(@"%@",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];

NSString *serviceName = 0;
NSString *serviceReg = 0;
NSString *serviceLevel = 0;
NSString *contract = 0;

int i = 0;
int numContracts = [[xml NumChildrenHavingTag: @"SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails"] intValue];
while (i < numContracts) {
    xml.I = [NSNumber numberWithInt: 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)"];
    NSLog(@"%@",serviceName);
    i = i + 1;
}