AdComposeWebService Web Service

AdComposeWebService

Click here for a complete list of operations.

GetDocumentLayout

Returns the document layout details.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /Forge.asmx HTTP/1.1
Host: service.adcomposegreen.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://adcompose.fairfax.com.au/greenservice/GetDocumentLayout"

<?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>
    <GetDocumentLayout xmlns="http://adcompose.fairfax.com.au/greenservice/">
      <DocumentID>int</DocumentID>
    </GetDocumentLayout>
  </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>
    <GetDocumentLayoutResponse xmlns="http://adcompose.fairfax.com.au/greenservice/">
      <GetDocumentLayoutResult>
        <ID>int</ID>
        <PropertyID>int</PropertyID>
        <HexID>string</HexID>
        <Height>int</Height>
        <Width>int</Width>
        <Guides>
          <Guide>
            <Type>int</Type>
            <Coordinate>int</Coordinate>
          </Guide>
          <Guide>
            <Type>int</Type>
            <Coordinate>int</Coordinate>
          </Guide>
        </Guides>
        <Modules>
          <Module>
            <ID>int</ID>
            <PropertyID>int</PropertyID>
            <HexID>string</HexID>
            <ImageID>int</ImageID>
            <SourceImageID>int</SourceImageID>
            <Height>int</Height>
            <Width>int</Width>
            <X>int</X>
            <Y>int</Y>
            <Z>int</Z>
          </Module>
          <Module>
            <ID>int</ID>
            <PropertyID>int</PropertyID>
            <HexID>string</HexID>
            <ImageID>int</ImageID>
            <SourceImageID>int</SourceImageID>
            <Height>int</Height>
            <Width>int</Width>
            <X>int</X>
            <Y>int</Y>
            <Z>int</Z>
          </Module>
        </Modules>
        <PageObjects>
          <PageObject>
            <ID>int</ID>
            <HexID>string</HexID>
            <Type>int</Type>
            <Height>int</Height>
            <Width>int</Width>
            <X>int</X>
            <Y>int</Y>
            <Z>int</Z>
          </PageObject>
          <PageObject>
            <ID>int</ID>
            <HexID>string</HexID>
            <Type>int</Type>
            <Height>int</Height>
            <Width>int</Width>
            <X>int</X>
            <Y>int</Y>
            <Z>int</Z>
          </PageObject>
        </PageObjects>
      </GetDocumentLayoutResult>
    </GetDocumentLayoutResponse>
  </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 /Forge.asmx HTTP/1.1
Host: service.adcomposegreen.com.au
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>
    <GetDocumentLayout xmlns="http://adcompose.fairfax.com.au/greenservice/">
      <DocumentID>int</DocumentID>
    </GetDocumentLayout>
  </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>
    <GetDocumentLayoutResponse xmlns="http://adcompose.fairfax.com.au/greenservice/">
      <GetDocumentLayoutResult>
        <ID>int</ID>
        <PropertyID>int</PropertyID>
        <HexID>string</HexID>
        <Height>int</Height>
        <Width>int</Width>
        <Guides>
          <Guide>
            <Type>int</Type>
            <Coordinate>int</Coordinate>
          </Guide>
          <Guide>
            <Type>int</Type>
            <Coordinate>int</Coordinate>
          </Guide>
        </Guides>
        <Modules>
          <Module>
            <ID>int</ID>
            <PropertyID>int</PropertyID>
            <HexID>string</HexID>
            <ImageID>int</ImageID>
            <SourceImageID>int</SourceImageID>
            <Height>int</Height>
            <Width>int</Width>
            <X>int</X>
            <Y>int</Y>
            <Z>int</Z>
          </Module>
          <Module>
            <ID>int</ID>
            <PropertyID>int</PropertyID>
            <HexID>string</HexID>
            <ImageID>int</ImageID>
            <SourceImageID>int</SourceImageID>
            <Height>int</Height>
            <Width>int</Width>
            <X>int</X>
            <Y>int</Y>
            <Z>int</Z>
          </Module>
        </Modules>
        <PageObjects>
          <PageObject>
            <ID>int</ID>
            <HexID>string</HexID>
            <Type>int</Type>
            <Height>int</Height>
            <Width>int</Width>
            <X>int</X>
            <Y>int</Y>
            <Z>int</Z>
          </PageObject>
          <PageObject>
            <ID>int</ID>
            <HexID>string</HexID>
            <Type>int</Type>
            <Height>int</Height>
            <Width>int</Width>
            <X>int</X>
            <Y>int</Y>
            <Z>int</Z>
          </PageObject>
        </PageObjects>
      </GetDocumentLayoutResult>
    </GetDocumentLayoutResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /Forge.asmx/GetDocumentLayout?DocumentID=string HTTP/1.1
Host: service.adcomposegreen.com.au

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

<?xml version="1.0" encoding="utf-8"?>
<DocumentLayout xmlns="http://adcompose.fairfax.com.au/greenservice/">
  <ID>int</ID>
  <PropertyID>int</PropertyID>
  <HexID>string</HexID>
  <Height>int</Height>
  <Width>int</Width>
  <Guides>
    <Guide>
      <Type>int</Type>
      <Coordinate>int</Coordinate>
    </Guide>
    <Guide>
      <Type>int</Type>
      <Coordinate>int</Coordinate>
    </Guide>
  </Guides>
  <Modules>
    <Module>
      <ID>int</ID>
      <PropertyID>int</PropertyID>
      <HexID>string</HexID>
      <ImageID>int</ImageID>
      <SourceImageID>int</SourceImageID>
      <Height>int</Height>
      <Width>int</Width>
      <X>int</X>
      <Y>int</Y>
      <Z>int</Z>
    </Module>
    <Module>
      <ID>int</ID>
      <PropertyID>int</PropertyID>
      <HexID>string</HexID>
      <ImageID>int</ImageID>
      <SourceImageID>int</SourceImageID>
      <Height>int</Height>
      <Width>int</Width>
      <X>int</X>
      <Y>int</Y>
      <Z>int</Z>
    </Module>
  </Modules>
  <PageObjects>
    <PageObject>
      <ID>int</ID>
      <HexID>string</HexID>
      <Type>int</Type>
      <Height>int</Height>
      <Width>int</Width>
      <X>int</X>
      <Y>int</Y>
      <Z>int</Z>
    </PageObject>
    <PageObject>
      <ID>int</ID>
      <HexID>string</HexID>
      <Type>int</Type>
      <Height>int</Height>
      <Width>int</Width>
      <X>int</X>
      <Y>int</Y>
      <Z>int</Z>
    </PageObject>
  </PageObjects>
</DocumentLayout>

HTTP POST

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

POST /Forge.asmx/GetDocumentLayout HTTP/1.1
Host: service.adcomposegreen.com.au
Content-Type: application/x-www-form-urlencoded
Content-Length: length

DocumentID=string

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

<?xml version="1.0" encoding="utf-8"?>
<DocumentLayout xmlns="http://adcompose.fairfax.com.au/greenservice/">
  <ID>int</ID>
  <PropertyID>int</PropertyID>
  <HexID>string</HexID>
  <Height>int</Height>
  <Width>int</Width>
  <Guides>
    <Guide>
      <Type>int</Type>
      <Coordinate>int</Coordinate>
    </Guide>
    <Guide>
      <Type>int</Type>
      <Coordinate>int</Coordinate>
    </Guide>
  </Guides>
  <Modules>
    <Module>
      <ID>int</ID>
      <PropertyID>int</PropertyID>
      <HexID>string</HexID>
      <ImageID>int</ImageID>
      <SourceImageID>int</SourceImageID>
      <Height>int</Height>
      <Width>int</Width>
      <X>int</X>
      <Y>int</Y>
      <Z>int</Z>
    </Module>
    <Module>
      <ID>int</ID>
      <PropertyID>int</PropertyID>
      <HexID>string</HexID>
      <ImageID>int</ImageID>
      <SourceImageID>int</SourceImageID>
      <Height>int</Height>
      <Width>int</Width>
      <X>int</X>
      <Y>int</Y>
      <Z>int</Z>
    </Module>
  </Modules>
  <PageObjects>
    <PageObject>
      <ID>int</ID>
      <HexID>string</HexID>
      <Type>int</Type>
      <Height>int</Height>
      <Width>int</Width>
      <X>int</X>
      <Y>int</Y>
      <Z>int</Z>
    </PageObject>
    <PageObject>
      <ID>int</ID>
      <HexID>string</HexID>
      <Type>int</Type>
      <Height>int</Height>
      <Width>int</Width>
      <X>int</X>
      <Y>int</Y>
      <Z>int</Z>
    </PageObject>
  </PageObjects>
</DocumentLayout>

Parameter	Value
DocumentID: