Wsf Web Service

Wsf

Click here for a complete list of operations.

GetFaxActivity

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 /webservice.asmx HTTP/1.1
Host: wsf.metrofax.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://wsf.metrofax.com/webservices/GetFaxActivity"

<?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>
    <GetFaxActivity xmlns="http://wsf.metrofax.com/webservices">
      <loginId>string</loginId>
      <password>string</password>
      <faxNumber>string</faxNumber>
      <billingCode1>string</billingCode1>
      <billingCode2>string</billingCode2>
      <startDate>string</startDate>
      <endDate>string</endDate>
      <includeDetails>boolean</includeDetails>
      <startRecord>int</startRecord>
      <maxRecords>int</maxRecords>
      <allNumbers>boolean</allNumbers>
    </GetFaxActivity>
  </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>
    <GetFaxActivityResponse xmlns="http://wsf.metrofax.com/webservices">
      <GetFaxActivityResult>
        <ResultString>string</ResultString>
        <ResultCode>int</ResultCode>
        <ErrorMessage>string</ErrorMessage>
        <Faxhistory>
          <FaxActivitySummary>
            <FaxNumber>string</FaxNumber>
            <BillingCode>string</BillingCode>
            <NumPagesIn>int</NumPagesIn>
            <NumPagesOut>int</NumPagesOut>
            <TotalPages>int</TotalPages>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <UsageCost>decimal</UsageCost>
            <IntlCost>decimal</IntlCost>
            <TotalCost>decimal</TotalCost>
            <Details xsi:nil="true" />
          </FaxActivitySummary>
          <FaxActivitySummary>
            <FaxNumber>string</FaxNumber>
            <BillingCode>string</BillingCode>
            <NumPagesIn>int</NumPagesIn>
            <NumPagesOut>int</NumPagesOut>
            <TotalPages>int</TotalPages>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <UsageCost>decimal</UsageCost>
            <IntlCost>decimal</IntlCost>
            <TotalCost>decimal</TotalCost>
            <Details xsi:nil="true" />
          </FaxActivitySummary>
        </Faxhistory>
      </GetFaxActivityResult>
    </GetFaxActivityResponse>
  </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 /webservice.asmx HTTP/1.1
Host: wsf.metrofax.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>
    <GetFaxActivity xmlns="http://wsf.metrofax.com/webservices">
      <loginId>string</loginId>
      <password>string</password>
      <faxNumber>string</faxNumber>
      <billingCode1>string</billingCode1>
      <billingCode2>string</billingCode2>
      <startDate>string</startDate>
      <endDate>string</endDate>
      <includeDetails>boolean</includeDetails>
      <startRecord>int</startRecord>
      <maxRecords>int</maxRecords>
      <allNumbers>boolean</allNumbers>
    </GetFaxActivity>
  </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>
    <GetFaxActivityResponse xmlns="http://wsf.metrofax.com/webservices">
      <GetFaxActivityResult>
        <ResultString>string</ResultString>
        <ResultCode>int</ResultCode>
        <ErrorMessage>string</ErrorMessage>
        <Faxhistory>
          <FaxActivitySummary>
            <FaxNumber>string</FaxNumber>
            <BillingCode>string</BillingCode>
            <NumPagesIn>int</NumPagesIn>
            <NumPagesOut>int</NumPagesOut>
            <TotalPages>int</TotalPages>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <UsageCost>decimal</UsageCost>
            <IntlCost>decimal</IntlCost>
            <TotalCost>decimal</TotalCost>
            <Details xsi:nil="true" />
          </FaxActivitySummary>
          <FaxActivitySummary>
            <FaxNumber>string</FaxNumber>
            <BillingCode>string</BillingCode>
            <NumPagesIn>int</NumPagesIn>
            <NumPagesOut>int</NumPagesOut>
            <TotalPages>int</TotalPages>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <UsageCost>decimal</UsageCost>
            <IntlCost>decimal</IntlCost>
            <TotalCost>decimal</TotalCost>
            <Details xsi:nil="true" />
          </FaxActivitySummary>
        </Faxhistory>
      </GetFaxActivityResult>
    </GetFaxActivityResponse>
  </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 /webservice.asmx/GetFaxActivity?loginId=string&password=string&faxNumber=string&billingCode1=string&billingCode2=string&startDate=string&endDate=string&includeDetails=string&startRecord=string&maxRecords=string&allNumbers=string HTTP/1.1
Host: wsf.metrofax.com

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

<?xml version="1.0" encoding="utf-8"?>
<FaxActivityResults xmlns="http://wsf.metrofax.com/webservices">
  <ResultString>string</ResultString>
  <ResultCode>int</ResultCode>
  <ErrorMessage>string</ErrorMessage>
  <Faxhistory>
    <FaxActivitySummary>
      <FaxNumber>string</FaxNumber>
      <BillingCode>string</BillingCode>
      <NumPagesIn>int</NumPagesIn>
      <NumPagesOut>int</NumPagesOut>
      <TotalPages>int</TotalPages>
      <StartDate>dateTime</StartDate>
      <EndDate>dateTime</EndDate>
      <UsageCost>decimal</UsageCost>
      <IntlCost>decimal</IntlCost>
      <TotalCost>decimal</TotalCost>
      <Details>
        <FaxActivityDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FaxActivityDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Details>
    </FaxActivitySummary>
    <FaxActivitySummary>
      <FaxNumber>string</FaxNumber>
      <BillingCode>string</BillingCode>
      <NumPagesIn>int</NumPagesIn>
      <NumPagesOut>int</NumPagesOut>
      <TotalPages>int</TotalPages>
      <StartDate>dateTime</StartDate>
      <EndDate>dateTime</EndDate>
      <UsageCost>decimal</UsageCost>
      <IntlCost>decimal</IntlCost>
      <TotalCost>decimal</TotalCost>
      <Details>
        <FaxActivityDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FaxActivityDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Details>
    </FaxActivitySummary>
  </Faxhistory>
</FaxActivityResults>

HTTP POST

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

POST /webservice.asmx/GetFaxActivity HTTP/1.1
Host: wsf.metrofax.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

loginId=string&password=string&faxNumber=string&billingCode1=string&billingCode2=string&startDate=string&endDate=string&includeDetails=string&startRecord=string&maxRecords=string&allNumbers=string

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

<?xml version="1.0" encoding="utf-8"?>
<FaxActivityResults xmlns="http://wsf.metrofax.com/webservices">
  <ResultString>string</ResultString>
  <ResultCode>int</ResultCode>
  <ErrorMessage>string</ErrorMessage>
  <Faxhistory>
    <FaxActivitySummary>
      <FaxNumber>string</FaxNumber>
      <BillingCode>string</BillingCode>
      <NumPagesIn>int</NumPagesIn>
      <NumPagesOut>int</NumPagesOut>
      <TotalPages>int</TotalPages>
      <StartDate>dateTime</StartDate>
      <EndDate>dateTime</EndDate>
      <UsageCost>decimal</UsageCost>
      <IntlCost>decimal</IntlCost>
      <TotalCost>decimal</TotalCost>
      <Details>
        <FaxActivityDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FaxActivityDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Details>
    </FaxActivitySummary>
    <FaxActivitySummary>
      <FaxNumber>string</FaxNumber>
      <BillingCode>string</BillingCode>
      <NumPagesIn>int</NumPagesIn>
      <NumPagesOut>int</NumPagesOut>
      <TotalPages>int</TotalPages>
      <StartDate>dateTime</StartDate>
      <EndDate>dateTime</EndDate>
      <UsageCost>decimal</UsageCost>
      <IntlCost>decimal</IntlCost>
      <TotalCost>decimal</TotalCost>
      <Details>
        <FaxActivityDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FaxActivityDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Details>
    </FaxActivitySummary>
  </Faxhistory>
</FaxActivityResults>