AdComposeWebService Web Service

AdComposeWebService

Click here for a complete list of operations.

GetAgents

Returns the usergroup agents.

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

<?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>
    <GetAgents xmlns="http://adcompose.fairfax.com.au/greenservice/">
      <groupId>int</groupId>
    </GetAgents>
  </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>
    <GetAgentsResponse xmlns="http://adcompose.fairfax.com.au/greenservice/">
      <GetAgentsResult>
        <Agent>
          <Name>string</Name>
          <ID>int</ID>
          <SetID>int</SetID>
          <FirstName>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </FirstName>
          <LastName>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </LastName>
          <Mobile>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Mobile>
          <Telephone>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Telephone>
          <Email>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Email>
          <Photo>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Photo>
        </Agent>
        <Agent>
          <Name>string</Name>
          <ID>int</ID>
          <SetID>int</SetID>
          <FirstName>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </FirstName>
          <LastName>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </LastName>
          <Mobile>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Mobile>
          <Telephone>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Telephone>
          <Email>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Email>
          <Photo>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Photo>
        </Agent>
      </GetAgentsResult>
    </GetAgentsResponse>
  </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>
    <GetAgents xmlns="http://adcompose.fairfax.com.au/greenservice/">
      <groupId>int</groupId>
    </GetAgents>
  </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>
    <GetAgentsResponse xmlns="http://adcompose.fairfax.com.au/greenservice/">
      <GetAgentsResult>
        <Agent>
          <Name>string</Name>
          <ID>int</ID>
          <SetID>int</SetID>
          <FirstName>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </FirstName>
          <LastName>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </LastName>
          <Mobile>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Mobile>
          <Telephone>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Telephone>
          <Email>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Email>
          <Photo>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Photo>
        </Agent>
        <Agent>
          <Name>string</Name>
          <ID>int</ID>
          <SetID>int</SetID>
          <FirstName>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </FirstName>
          <LastName>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </LastName>
          <Mobile>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Mobile>
          <Telephone>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Telephone>
          <Email>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Email>
          <Photo>
            <Name>string</Name>
            <Value>string</Value>
            <Max>int</Max>
            <Type>int</Type>
            <MetaData>string</MetaData>
          </Photo>
        </Agent>
      </GetAgentsResult>
    </GetAgentsResponse>
  </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/GetAgents?groupId=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"?>
<ArrayOfAgent xmlns="http://adcompose.fairfax.com.au/greenservice/">
  <Agent>
    <Name>string</Name>
    <ID>int</ID>
    <SetID>int</SetID>
    <FirstName>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </FirstName>
    <LastName>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </LastName>
    <Mobile>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Mobile>
    <Telephone>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Telephone>
    <Email>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Email>
    <Photo>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Photo>
  </Agent>
  <Agent>
    <Name>string</Name>
    <ID>int</ID>
    <SetID>int</SetID>
    <FirstName>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </FirstName>
    <LastName>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </LastName>
    <Mobile>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Mobile>
    <Telephone>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Telephone>
    <Email>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Email>
    <Photo>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Photo>
  </Agent>
</ArrayOfAgent>

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/GetAgents HTTP/1.1
Host: service.adcomposegreen.com.au
Content-Type: application/x-www-form-urlencoded
Content-Length: length

groupId=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfAgent xmlns="http://adcompose.fairfax.com.au/greenservice/">
  <Agent>
    <Name>string</Name>
    <ID>int</ID>
    <SetID>int</SetID>
    <FirstName>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </FirstName>
    <LastName>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </LastName>
    <Mobile>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Mobile>
    <Telephone>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Telephone>
    <Email>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Email>
    <Photo>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Photo>
  </Agent>
  <Agent>
    <Name>string</Name>
    <ID>int</ID>
    <SetID>int</SetID>
    <FirstName>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </FirstName>
    <LastName>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </LastName>
    <Mobile>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Mobile>
    <Telephone>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Telephone>
    <Email>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Email>
    <Photo>
      <Name>string</Name>
      <Value>string</Value>
      <Max>int</Max>
      <Type>int</Type>
      <MetaData>string</MetaData>
    </Photo>
  </Agent>
</ArrayOfAgent>

Parameter	Value
groupId: