ExternalCollection Web Service

ExternalCollection

Click here for a complete list of operations.

GetContentPageByName

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /ExternalResources/ExternalCollection.asmx HTTP/1.1
Host: mafsteel.co.za
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetContentPageByName"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContentPageByName xmlns="http://tempuri.org/">
      <Name>string</Name>
    </GetContentPageByName>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetContentPageByNameResponse xmlns="http://tempuri.org/">
      <GetContentPageByNameResult>
        <Id>int</Id>
        <ParentId>int</ParentId>
        <Name>string</Name>
        <Title>string</Title>
        <ShortDescription>string</ShortDescription>
        <WholeDescription>string</WholeDescription>
        <UrlTitle>string</UrlTitle>
        <HeaderImageUrl>string</HeaderImageUrl>
        <HeaderImageAlt>string</HeaderImageAlt>
        <Order>int</Order>
        <ShowTitle>boolean</ShowTitle>
        <CreatedBy>string</CreatedBy>
        <CreatedDate>dateTime</CreatedDate>
        <IsDeleted>boolean</IsDeleted>
        <Forums>
          <Forum>
            <Id>int</Id>
            <PageId>int</PageId>
            <Name>string</Name>
            <Urltitle>string</Urltitle>
            <ShortDescription>string</ShortDescription>
            <WholeDescription>string</WholeDescription>
            <SecureContent>string</SecureContent>
            <SecureContentHeading>string</SecureContentHeading>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <Order>int</Order>
            <CreatedBy>string</CreatedBy>
            <CreatedDate>dateTime</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
            <ContentPage xsi:nil="true" />
          </Forum>
          <Forum>
            <Id>int</Id>
            <PageId>int</PageId>
            <Name>string</Name>
            <Urltitle>string</Urltitle>
            <ShortDescription>string</ShortDescription>
            <WholeDescription>string</WholeDescription>
            <SecureContent>string</SecureContent>
            <SecureContentHeading>string</SecureContentHeading>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <Order>int</Order>
            <CreatedBy>string</CreatedBy>
            <CreatedDate>dateTime</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
            <ContentPage xsi:nil="true" />
          </Forum>
        </Forums>
        <SEOs>
          <SEO>
            <Id>int</Id>
            <PageId>int</PageId>
            <Title>string</Title>
            <Description>string</Description>
            <Keywords>string</Keywords>
            <CreatedBy>string</CreatedBy>
            <CreatedDate>dateTime</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
            <ContentPage xsi:nil="true" />
          </SEO>
          <SEO>
            <Id>int</Id>
            <PageId>int</PageId>
            <Title>string</Title>
            <Description>string</Description>
            <Keywords>string</Keywords>
            <CreatedBy>string</CreatedBy>
            <CreatedDate>dateTime</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
            <ContentPage xsi:nil="true" />
          </SEO>
        </SEOs>
        <FeatureItems>
          <FeatureItem>
            <Id>int</Id>
            <PageId>int</PageId>
            <Name>string</Name>
            <Title>string</Title>
            <Type>string</Type>
            <ImageOnly>boolean</ImageOnly>
            <Text1>string</Text1>
            <Text2>string</Text2>
            <MoreUrl>string</MoreUrl>
            <MoreText>string</MoreText>
            <ClassName>string</ClassName>
            <Order>int</Order>
            <Size>int</Size>
            <IsBlank>boolean</IsBlank>
            <IsLive>boolean</IsLive>
            <CreatedBy>string</CreatedBy>
            <CreatedDate>dateTime</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
            <ContentPage xsi:nil="true" />
          </FeatureItem>
          <FeatureItem>
            <Id>int</Id>
            <PageId>int</PageId>
            <Name>string</Name>
            <Title>string</Title>
            <Type>string</Type>
            <ImageOnly>boolean</ImageOnly>
            <Text1>string</Text1>
            <Text2>string</Text2>
            <MoreUrl>string</MoreUrl>
            <MoreText>string</MoreText>
            <ClassName>string</ClassName>
            <Order>int</Order>
            <Size>int</Size>
            <IsBlank>boolean</IsBlank>
            <IsLive>boolean</IsLive>
            <CreatedBy>string</CreatedBy>
            <CreatedDate>dateTime</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
            <ContentPage xsi:nil="true" />
          </FeatureItem>
        </FeatureItems>
      </GetContentPageByNameResult>
    </GetContentPageByNameResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /ExternalResources/ExternalCollection.asmx HTTP/1.1
Host: mafsteel.co.za
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetContentPageByName xmlns="http://tempuri.org/">
      <Name>string</Name>
    </GetContentPageByName>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetContentPageByNameResponse xmlns="http://tempuri.org/">
      <GetContentPageByNameResult>
        <Id>int</Id>
        <ParentId>int</ParentId>
        <Name>string</Name>
        <Title>string</Title>
        <ShortDescription>string</ShortDescription>
        <WholeDescription>string</WholeDescription>
        <UrlTitle>string</UrlTitle>
        <HeaderImageUrl>string</HeaderImageUrl>
        <HeaderImageAlt>string</HeaderImageAlt>
        <Order>int</Order>
        <ShowTitle>boolean</ShowTitle>
        <CreatedBy>string</CreatedBy>
        <CreatedDate>dateTime</CreatedDate>
        <IsDeleted>boolean</IsDeleted>
        <Forums>
          <Forum>
            <Id>int</Id>
            <PageId>int</PageId>
            <Name>string</Name>
            <Urltitle>string</Urltitle>
            <ShortDescription>string</ShortDescription>
            <WholeDescription>string</WholeDescription>
            <SecureContent>string</SecureContent>
            <SecureContentHeading>string</SecureContentHeading>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <Order>int</Order>
            <CreatedBy>string</CreatedBy>
            <CreatedDate>dateTime</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
            <ContentPage xsi:nil="true" />
          </Forum>
          <Forum>
            <Id>int</Id>
            <PageId>int</PageId>
            <Name>string</Name>
            <Urltitle>string</Urltitle>
            <ShortDescription>string</ShortDescription>
            <WholeDescription>string</WholeDescription>
            <SecureContent>string</SecureContent>
            <SecureContentHeading>string</SecureContentHeading>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <Order>int</Order>
            <CreatedBy>string</CreatedBy>
            <CreatedDate>dateTime</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
            <ContentPage xsi:nil="true" />
          </Forum>
        </Forums>
        <SEOs>
          <SEO>
            <Id>int</Id>
            <PageId>int</PageId>
            <Title>string</Title>
            <Description>string</Description>
            <Keywords>string</Keywords>
            <CreatedBy>string</CreatedBy>
            <CreatedDate>dateTime</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
            <ContentPage xsi:nil="true" />
          </SEO>
          <SEO>
            <Id>int</Id>
            <PageId>int</PageId>
            <Title>string</Title>
            <Description>string</Description>
            <Keywords>string</Keywords>
            <CreatedBy>string</CreatedBy>
            <CreatedDate>dateTime</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
            <ContentPage xsi:nil="true" />
          </SEO>
        </SEOs>
        <FeatureItems>
          <FeatureItem>
            <Id>int</Id>
            <PageId>int</PageId>
            <Name>string</Name>
            <Title>string</Title>
            <Type>string</Type>
            <ImageOnly>boolean</ImageOnly>
            <Text1>string</Text1>
            <Text2>string</Text2>
            <MoreUrl>string</MoreUrl>
            <MoreText>string</MoreText>
            <ClassName>string</ClassName>
            <Order>int</Order>
            <Size>int</Size>
            <IsBlank>boolean</IsBlank>
            <IsLive>boolean</IsLive>
            <CreatedBy>string</CreatedBy>
            <CreatedDate>dateTime</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
            <ContentPage xsi:nil="true" />
          </FeatureItem>
          <FeatureItem>
            <Id>int</Id>
            <PageId>int</PageId>
            <Name>string</Name>
            <Title>string</Title>
            <Type>string</Type>
            <ImageOnly>boolean</ImageOnly>
            <Text1>string</Text1>
            <Text2>string</Text2>
            <MoreUrl>string</MoreUrl>
            <MoreText>string</MoreText>
            <ClassName>string</ClassName>
            <Order>int</Order>
            <Size>int</Size>
            <IsBlank>boolean</IsBlank>
            <IsLive>boolean</IsLive>
            <CreatedBy>string</CreatedBy>
            <CreatedDate>dateTime</CreatedDate>
            <IsDeleted>boolean</IsDeleted>
            <ContentPage xsi:nil="true" />
          </FeatureItem>
        </FeatureItems>
      </GetContentPageByNameResult>
    </GetContentPageByNameResponse>
  </soap12:Body>
</soap12:Envelope>