Admin Web Service

Admin

Click here for a complete list of operations.

GetCoverpagesAssignedToGroup

Returns group cover pages

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 /admin.asmx HTTP/1.1
Host: ws.interfax.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://interfax.net/Admin/GetCoverpagesAssignedToGroup"

<?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>
    <GetCoverpagesAssignedToGroup xmlns="http://interfax.net/Admin">
      <PrimaryUserID>string</PrimaryUserID>
      <Password>string</Password>
      <groupId>unsignedInt</groupId>
    </GetCoverpagesAssignedToGroup>
  </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>
    <GetCoverpagesAssignedToGroupResponse xmlns="http://interfax.net/Admin">
      <GetCoverpagesAssignedToGroupResult>
        <ResultCode>int</ResultCode>
        <Coverpages>
          <AccountCoverPage>
            <AccountId>unsignedInt</AccountId>
            <Name>string</Name>
            <HtmlBody>string</HtmlBody>
            <BinaryBody xsi:nil="true" />
            <Header>string</Header>
            <Footer>string</Footer>
            <Type>MessageOnly or Html or PDF</Type>
            <CoverpageBodyType>None or Text or Html</CoverpageBodyType>
            <IsPublic>boolean</IsPublic>
          </AccountCoverPage>
          <AccountCoverPage>
            <AccountId>unsignedInt</AccountId>
            <Name>string</Name>
            <HtmlBody>string</HtmlBody>
            <BinaryBody xsi:nil="true" />
            <Header>string</Header>
            <Footer>string</Footer>
            <Type>MessageOnly or Html or PDF</Type>
            <CoverpageBodyType>None or Text or Html</CoverpageBodyType>
            <IsPublic>boolean</IsPublic>
          </AccountCoverPage>
        </Coverpages>
      </GetCoverpagesAssignedToGroupResult>
    </GetCoverpagesAssignedToGroupResponse>
  </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 /admin.asmx HTTP/1.1
Host: ws.interfax.net
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>
    <GetCoverpagesAssignedToGroup xmlns="http://interfax.net/Admin">
      <PrimaryUserID>string</PrimaryUserID>
      <Password>string</Password>
      <groupId>unsignedInt</groupId>
    </GetCoverpagesAssignedToGroup>
  </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>
    <GetCoverpagesAssignedToGroupResponse xmlns="http://interfax.net/Admin">
      <GetCoverpagesAssignedToGroupResult>
        <ResultCode>int</ResultCode>
        <Coverpages>
          <AccountCoverPage>
            <AccountId>unsignedInt</AccountId>
            <Name>string</Name>
            <HtmlBody>string</HtmlBody>
            <BinaryBody xsi:nil="true" />
            <Header>string</Header>
            <Footer>string</Footer>
            <Type>MessageOnly or Html or PDF</Type>
            <CoverpageBodyType>None or Text or Html</CoverpageBodyType>
            <IsPublic>boolean</IsPublic>
          </AccountCoverPage>
          <AccountCoverPage>
            <AccountId>unsignedInt</AccountId>
            <Name>string</Name>
            <HtmlBody>string</HtmlBody>
            <BinaryBody xsi:nil="true" />
            <Header>string</Header>
            <Footer>string</Footer>
            <Type>MessageOnly or Html or PDF</Type>
            <CoverpageBodyType>None or Text or Html</CoverpageBodyType>
            <IsPublic>boolean</IsPublic>
          </AccountCoverPage>
        </Coverpages>
      </GetCoverpagesAssignedToGroupResult>
    </GetCoverpagesAssignedToGroupResponse>
  </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 /admin.asmx/GetCoverpagesAssignedToGroup?PrimaryUserID=string&Password=string&groupId=string HTTP/1.1
Host: ws.interfax.net

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

<?xml version="1.0" encoding="utf-8"?>
<GroupCoverpageResults xmlns="http://interfax.net/Admin">
  <ResultCode>int</ResultCode>
  <Coverpages>
    <AccountCoverPage>
      <AccountId>unsignedInt</AccountId>
      <Name>string</Name>
      <HtmlBody>string</HtmlBody>
      <BinaryBody>
        <unsignedByte>unsignedByte</unsignedByte>
        <unsignedByte>unsignedByte</unsignedByte>
      </BinaryBody>
      <Header>string</Header>
      <Footer>string</Footer>
      <Type>MessageOnly or Html or PDF</Type>
      <CoverpageBodyType>None or Text or Html</CoverpageBodyType>
      <IsPublic>boolean</IsPublic>
    </AccountCoverPage>
    <AccountCoverPage>
      <AccountId>unsignedInt</AccountId>
      <Name>string</Name>
      <HtmlBody>string</HtmlBody>
      <BinaryBody>
        <unsignedByte>unsignedByte</unsignedByte>
        <unsignedByte>unsignedByte</unsignedByte>
      </BinaryBody>
      <Header>string</Header>
      <Footer>string</Footer>
      <Type>MessageOnly or Html or PDF</Type>
      <CoverpageBodyType>None or Text or Html</CoverpageBodyType>
      <IsPublic>boolean</IsPublic>
    </AccountCoverPage>
  </Coverpages>
</GroupCoverpageResults>

HTTP POST

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

POST /admin.asmx/GetCoverpagesAssignedToGroup HTTP/1.1
Host: ws.interfax.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

PrimaryUserID=string&Password=string&groupId=string

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

<?xml version="1.0" encoding="utf-8"?>
<GroupCoverpageResults xmlns="http://interfax.net/Admin">
  <ResultCode>int</ResultCode>
  <Coverpages>
    <AccountCoverPage>
      <AccountId>unsignedInt</AccountId>
      <Name>string</Name>
      <HtmlBody>string</HtmlBody>
      <BinaryBody>
        <unsignedByte>unsignedByte</unsignedByte>
        <unsignedByte>unsignedByte</unsignedByte>
      </BinaryBody>
      <Header>string</Header>
      <Footer>string</Footer>
      <Type>MessageOnly or Html or PDF</Type>
      <CoverpageBodyType>None or Text or Html</CoverpageBodyType>
      <IsPublic>boolean</IsPublic>
    </AccountCoverPage>
    <AccountCoverPage>
      <AccountId>unsignedInt</AccountId>
      <Name>string</Name>
      <HtmlBody>string</HtmlBody>
      <BinaryBody>
        <unsignedByte>unsignedByte</unsignedByte>
        <unsignedByte>unsignedByte</unsignedByte>
      </BinaryBody>
      <Header>string</Header>
      <Footer>string</Footer>
      <Type>MessageOnly or Html or PDF</Type>
      <CoverpageBodyType>None or Text or Html</CoverpageBodyType>
      <IsPublic>boolean</IsPublic>
    </AccountCoverPage>
  </Coverpages>
</GroupCoverpageResults>

Parameter	Value
PrimaryUserID:
Password:
groupId: