Sample code for 30+ languages & platforms
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.

Chilkat C Downloads

C
#include <C_CkXml.h>
#include <C_CkHttp.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkXml xml;
    HCkHttp http;
    const char *endpointUrl;
    HCkHttpResponse resp;
    const char *serviceName;
    const char *serviceReg;
    const char *serviceLevel;
    const char *contract;
    int i;
    int numContracts;

    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>

    xml = CkXml_Create();
    CkXml_putEmitXmlDecl(xml,FALSE);
    CkXml_putTag(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");

    http = CkHttp_Create();

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

    resp = CkHttpResponse_Create();
    success = CkHttp_HttpStr(http,"POST",endpointUrl,CkXml_getXml(xml),"utf-8","text/xml",resp);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkXml_Dispose(xml);
        CkHttp_Dispose(http);
        CkHttpResponse_Dispose(resp);
        return;
    }

    printf("response status code = %d\n",CkHttpResponse_getStatusCode(resp));
    printf("%s\n",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));

    i = 0;
    numContracts = CkXml_NumChildrenHavingTag(xml,"SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails");
    while (i < numContracts) {
        CkXml_putI(xml,i);
        serviceName = CkXml_chilkatPath(xml,"SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceName)");
        serviceReg = CkXml_chilkatPath(xml,"SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceReg)");
        serviceLevel = CkXml_chilkatPath(xml,"SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(ServiceLevel)");
        contract = CkXml_chilkatPath(xml,"SOAP-ENV:Body|ns1:GetContractsResponse|ns1:GetContractsResult|ns1:Contracts|ns1:ContractDetails[i]|(Contract)");
        printf("%s\n",serviceName);
        i = i + 1;
    }



    CkXml_Dispose(xml);
    CkHttp_Dispose(http);
    CkHttpResponse_Dispose(resp);

    }