Admin Web Service

Admin

Click here for a complete list of operations.

GetAccountCoverpage

Returns account's cover page by id

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

<?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>
    <GetAccountCoverpage xmlns="http://interfax.net/Admin">
      <PrimaryUserID>string</PrimaryUserID>
      <Password>string</Password>
      <coverPageId>unsignedInt</coverPageId>
    </GetAccountCoverpage>
  </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>
    <GetAccountCoverpageResponse xmlns="http://interfax.net/Admin">
      <GetAccountCoverpageResult>
        <ResultCode>int</ResultCode>
        <Coverpage>
          <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>
        </Coverpage>
      </GetAccountCoverpageResult>
    </GetAccountCoverpageResponse>
  </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>
    <GetAccountCoverpage xmlns="http://interfax.net/Admin">
      <PrimaryUserID>string</PrimaryUserID>
      <Password>string</Password>
      <coverPageId>unsignedInt</coverPageId>
    </GetAccountCoverpage>
  </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>
    <GetAccountCoverpageResponse xmlns="http://interfax.net/Admin">
      <GetAccountCoverpageResult>
        <ResultCode>int</ResultCode>
        <Coverpage>
          <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>
        </Coverpage>
      </GetAccountCoverpageResult>
    </GetAccountCoverpageResponse>
  </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/GetAccountCoverpage?PrimaryUserID=string&Password=string&coverPageId=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"?>
<AccountCoverpageResult xmlns="http://interfax.net/Admin">
  <ResultCode>int</ResultCode>
  <Coverpage>
    <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>
  </Coverpage>
</AccountCoverpageResult>

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/GetAccountCoverpage HTTP/1.1
Host: ws.interfax.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

PrimaryUserID=string&Password=string&coverPageId=string

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

<?xml version="1.0" encoding="utf-8"?>
<AccountCoverpageResult xmlns="http://interfax.net/Admin">
  <ResultCode>int</ResultCode>
  <Coverpage>
    <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>
  </Coverpage>
</AccountCoverpageResult>

Parameter	Value
PrimaryUserID:
Password:
coverPageId: