OrganisationServiceBasicHttpEndpoint / SearchByScope

ASP AutoIt C C (Unicode) C++ C++ (Unicode) C# DataFlex Delphi Foxpro Go Java Node.js Objective-C Perl PHP Extension PowerBuilder Powershell PureBasic Python CkPython Ruby SQL Server Swift TCL VB.NET VB6 VBScript Xojo

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

void ChilkatSample(void)
    {
    HCkXml xml;
    const char *soapRequestBody;
    const char *endpoint;
    const char *soapAction;
    const char *contentType;
    HCkHttp http;
    HCkHttpResponse resp;
    HCkXml responseXml;
    int statusCode;
    int Count;
    int PageNumber;
    int PageSize;
    const char *Code;
    const char *DataManagerCode;
    const char *HasActiveRegistration;
    const char *IsLegacyData;
    const char *LegalPersonName;
    const char *RegistrationStatus;
    const char *TradingName;
    const char *DateTime;
    int OffsetMinutes;

    xml = CkXml_Create();
    CkXml_putTag(xml,"soapenv:Envelope");
    CkXml_AddAttribute(xml,"xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/");
    CkXml_AddAttribute(xml,"xmlns:tra","http://training.gov.au/services/12/");
    CkXml_AddAttribute(xml,"xmlns:arr","http://schemas.microsoft.com/2003/10/Serialization/Arrays");
    CkXml_UpdateChildContent(xml,"soapenv:Header","");
    CkXml_UpdateChildContentInt(xml,"soapenv:Body|tra:SearchByScope|tra:request|tra:PageNumber",1042);
    CkXml_UpdateChildContentInt(xml,"soapenv:Body|tra:SearchByScope|tra:request|tra:PageSize",1042);
    CkXml_UpdateChildContent(xml,"soapenv:Body|tra:SearchByScope|tra:request|tra:Filter","string");
    CkXml_UpdateChildContent(xml,"soapenv:Body|tra:SearchByScope|tra:request|tra:IncludeImplicitScope","true");
    CkXml_UpdateChildContent(xml,"soapenv:Body|tra:SearchByScope|tra:request|tra:IncludeLegacyData","true");
    CkXml_UpdateChildContent(xml,"soapenv:Body|tra:SearchByScope|tra:request|tra:RegistrationManagers|arr:string","string");
    CkXml_UpdateChildContent(xml,"soapenv:Body|tra:SearchByScope|tra:request|tra:SearchTrainingPackageContents","true");

    // In a SOAP HTTP request, including the XML declaration (<?xml version="1.0" encoding="UTF-8"?>) in the XML body is generally not required. 
    CkXml_putEmitXmlDecl(xml,FALSE);
    soapRequestBody = CkXml_getXml(xml);

    endpoint = "https://ws.staging.training.gov.au/Deewr.Tga.WebServices/OrganisationServiceV12.svc/Organisation";
    soapAction = "http://training.gov.au/services/12/IOrganisationService/SearchByScope";
    //  For SOAP requests, the standard Content-Type is usually set to "text/xml" or "application/soap+xml"
    contentType = "text/xml";

    http = CkHttp_Create();

    CkHttp_ClearHeaders(http);
    CkHttp_SetRequestHeader(http,"Content-Type",contentType);
    CkHttp_SetRequestHeader(http,"SOAPAction",soapAction);

    resp = CkHttp_PostXml(http,endpoint,soapRequestBody,"utf-8");
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        printf("Failed to send SOAP request.\n");
        CkXml_Dispose(xml);
        CkHttp_Dispose(http);
        return;
    }

    // Get the XML response body.
    responseXml = CkXml_Create();
    CkHttpResponse_GetBodyXml(resp,responseXml);

    statusCode = CkHttpResponse_getStatusCode(resp);
    printf("response status code: %d\n",statusCode);

    CkHttpResponse_Dispose(resp);

    // If the status code does not indicate succcess, then show the response XML,
    // which probably contains error information.
    if (statusCode != 200) {
        printf("%s\n",CkXml_getXml(responseXml));
        CkXml_Dispose(xml);
        CkHttp_Dispose(http);
        CkXml_Dispose(responseXml);
        return;
    }

    printf("%s\n",CkXml_getXml(responseXml));

    // Parse the successful SOAP response XML.

    // This is a sample of the response XML, but the namespace prefixes will be different.
    // We can parse the result using "*" for the namespace prefixes (see below).

    Count = CkXml_GetChildIntValue(responseXml,"*:Body|*:SearchByScopeResponse|*:SearchByScopeResult|*:Count");
    PageNumber = CkXml_GetChildIntValue(responseXml,"*:Body|*:SearchByScopeResponse|*:SearchByScopeResult|*:PageNumber");
    PageSize = CkXml_GetChildIntValue(responseXml,"*:Body|*:SearchByScopeResponse|*:SearchByScopeResult|*:PageSize");
    Code = CkXml_getChildContent(responseXml,"*:Body|*:SearchByScopeResponse|*:SearchByScopeResult|*:Results|*:OrganisationSearchResultItem|*:Code");
    DataManagerCode = CkXml_getChildContent(responseXml,"*:Body|*:SearchByScopeResponse|*:SearchByScopeResult|*:Results|*:OrganisationSearchResultItem|*:DataManagerCode");
    HasActiveRegistration = CkXml_getChildContent(responseXml,"*:Body|*:SearchByScopeResponse|*:SearchByScopeResult|*:Results|*:OrganisationSearchResultItem|*:HasActiveRegistration");
    IsLegacyData = CkXml_getChildContent(responseXml,"*:Body|*:SearchByScopeResponse|*:SearchByScopeResult|*:Results|*:OrganisationSearchResultItem|*:IsLegacyData");
    LegalPersonName = CkXml_getChildContent(responseXml,"*:Body|*:SearchByScopeResponse|*:SearchByScopeResult|*:Results|*:OrganisationSearchResultItem|*:LegalPersonName");
    RegistrationStatus = CkXml_getChildContent(responseXml,"*:Body|*:SearchByScopeResponse|*:SearchByScopeResult|*:Results|*:OrganisationSearchResultItem|*:RegistrationStatus");
    TradingName = CkXml_getChildContent(responseXml,"*:Body|*:SearchByScopeResponse|*:SearchByScopeResult|*:Results|*:OrganisationSearchResultItem|*:TradingName");
    DateTime = CkXml_getChildContent(responseXml,"*:Body|*:SearchByScopeResponse|*:SearchByScopeResult|*:Results|*:OrganisationSearchResultItem|*:UpdatedDate|*:DateTime");
    OffsetMinutes = CkXml_GetChildIntValue(responseXml,"*:Body|*:SearchByScopeResponse|*:SearchByScopeResult|*:Results|*:OrganisationSearchResultItem|*:UpdatedDate|*:OffsetMinutes");


    CkXml_Dispose(xml);
    CkHttp_Dispose(http);
    CkXml_Dispose(responseXml);

    }

Request XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tra="http://training.gov.au/services/12/" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <soapenv:Header/>
    <soapenv:Body>
        <tra:SearchByScope>
            <tra:request>
                <tra:PageNumber>1042</tra:PageNumber>
                <tra:PageSize>1042</tra:PageSize>
                <tra:Filter>string</tra:Filter>
                <tra:IncludeImplicitScope>true</tra:IncludeImplicitScope>
                <tra:IncludeLegacyData>true</tra:IncludeLegacyData>
                <tra:RegistrationManagers>
                    <arr:string>string</arr:string>
                </tra:RegistrationManagers>
                <tra:SearchTrainingPackageContents>true</tra:SearchTrainingPackageContents>
            </tra:request>
        </tra:SearchByScope>
    </soapenv:Body>
</soapenv:Envelope>

Response XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tra="http://training.gov.au/services/12/" xmlns:sys="http://schemas.datacontract.org/2004/07/System">
    <soapenv:Header/>
    <soapenv:Body>
        <tra:SearchByScopeResponse>
            <tra:SearchByScopeResult>
                <tra:Count>1042</tra:Count>
                <tra:PageNumber>1042</tra:PageNumber>
                <tra:PageSize>1042</tra:PageSize>
                <tra:Results>
                    <tra:OrganisationSearchResultItem>
                        <tra:Code>string</tra:Code>
                        <tra:DataManagerCode>string</tra:DataManagerCode>
                        <tra:HasActiveRegistration>true</tra:HasActiveRegistration>
                        <tra:IsLegacyData>true</tra:IsLegacyData>
                        <tra:LegalPersonName>string</tra:LegalPersonName>
                        <tra:RegistrationStatus>string</tra:RegistrationStatus>
                        <tra:TradingName>string</tra:TradingName>
                        <tra:UpdatedDate>
                            <sys:DateTime>dateTime</sys:DateTime>
                            <sys:OffsetMinutes>442</sys:OffsetMinutes>
                        </tra:UpdatedDate>
                    </tra:OrganisationSearchResultItem>
                </tra:Results>
            </tra:SearchByScopeResult>
        </tra:SearchByScopeResponse>
    </soapenv:Body>
</soapenv:Envelope>