AccountManagementCoverPageWebservice Web Service

AccountManagementCoverPageWebservice

Click here for a complete list of operations.

ListCoverPages

Method to list the cover pages for a company, department or user account

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 /acctmgmt/v4.5/coverpage.asmx HTTP/1.1
Host: ws.gfifax.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "AccountManagementCoverPageWebservice/ListCoverPages"

<?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>
    <ListCoverPages xmlns="AccountManagementCoverPageWebservice">
      <request>
        <Authentication>
          <Password>string</Password>
          <Username>string</Username>
        </Authentication>
        <CustomerId>int</CustomerId>
        <Filters>
          <string>string</string>
          <string>string</string>
        </Filters>
      </request>
    </ListCoverPages>
  </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>
    <ListCoverPagesResponse xmlns="AccountManagementCoverPageWebservice">
      <ListCoverPagesResult>
        <Code>int</Code>
        <CoverPageList>
          <CoverPageItem>
            <ContentType>int</ContentType>
            <ContentTypeDescription>string</ContentTypeDescription>
            <CoverPageId>int</CoverPageId>
            <CreatedDate>dateTime</CreatedDate>
            <Description>string</Description>
            <LastModifiedDate>dateTime</LastModifiedDate>
            <Name>string</Name>
            <OwnerId>int</OwnerId>
            <OwnerType>string</OwnerType>
            <ParentCustomerId>int</ParentCustomerId>
            <StatusDescription>string</StatusDescription>
            <StatusId>int</StatusId>
          </CoverPageItem>
          <CoverPageItem>
            <ContentType>int</ContentType>
            <ContentTypeDescription>string</ContentTypeDescription>
            <CoverPageId>int</CoverPageId>
            <CreatedDate>dateTime</CreatedDate>
            <Description>string</Description>
            <LastModifiedDate>dateTime</LastModifiedDate>
            <Name>string</Name>
            <OwnerId>int</OwnerId>
            <OwnerType>string</OwnerType>
            <ParentCustomerId>int</ParentCustomerId>
            <StatusDescription>string</StatusDescription>
            <StatusId>int</StatusId>
          </CoverPageItem>
        </CoverPageList>
        <Message>string</Message>
        <Success>boolean</Success>
      </ListCoverPagesResult>
    </ListCoverPagesResponse>
  </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 /acctmgmt/v4.5/coverpage.asmx HTTP/1.1
Host: ws.gfifax.com
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>
    <ListCoverPages xmlns="AccountManagementCoverPageWebservice">
      <request>
        <Authentication>
          <Password>string</Password>
          <Username>string</Username>
        </Authentication>
        <CustomerId>int</CustomerId>
        <Filters>
          <string>string</string>
          <string>string</string>
        </Filters>
      </request>
    </ListCoverPages>
  </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>
    <ListCoverPagesResponse xmlns="AccountManagementCoverPageWebservice">
      <ListCoverPagesResult>
        <Code>int</Code>
        <CoverPageList>
          <CoverPageItem>
            <ContentType>int</ContentType>
            <ContentTypeDescription>string</ContentTypeDescription>
            <CoverPageId>int</CoverPageId>
            <CreatedDate>dateTime</CreatedDate>
            <Description>string</Description>
            <LastModifiedDate>dateTime</LastModifiedDate>
            <Name>string</Name>
            <OwnerId>int</OwnerId>
            <OwnerType>string</OwnerType>
            <ParentCustomerId>int</ParentCustomerId>
            <StatusDescription>string</StatusDescription>
            <StatusId>int</StatusId>
          </CoverPageItem>
          <CoverPageItem>
            <ContentType>int</ContentType>
            <ContentTypeDescription>string</ContentTypeDescription>
            <CoverPageId>int</CoverPageId>
            <CreatedDate>dateTime</CreatedDate>
            <Description>string</Description>
            <LastModifiedDate>dateTime</LastModifiedDate>
            <Name>string</Name>
            <OwnerId>int</OwnerId>
            <OwnerType>string</OwnerType>
            <ParentCustomerId>int</ParentCustomerId>
            <StatusDescription>string</StatusDescription>
            <StatusId>int</StatusId>
          </CoverPageItem>
        </CoverPageList>
        <Message>string</Message>
        <Success>boolean</Success>
      </ListCoverPagesResult>
    </ListCoverPagesResponse>
  </soap12:Body>
</soap12:Envelope>