Wsf Web Service

Wsf

Click here for a complete list of operations.

ListOutboundMessages

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

<?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>
    <ListOutboundMessages xmlns="http://wsf.metrofax.com/webservices">
      <loginId>string</loginId>
      <password>string</password>
      <startDate>string</startDate>
      <endDate>string</endDate>
      <filter>string</filter>
      <sortColumns>string</sortColumns>
      <startRecord>int</startRecord>
      <maxRecords>int</maxRecords>
      <faxNumbers>
        <string>string</string>
        <string>string</string>
      </faxNumbers>
    </ListOutboundMessages>
  </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>
    <ListOutboundMessagesResponse xmlns="http://wsf.metrofax.com/webservices">
      <ListOutboundMessagesResult>
        <ResultCode>int</ResultCode>
        <ErrorMessage>string</ErrorMessage>
        <TotalRecords>int</TotalRecords>
        <Count>int</Count>
        <Items>
          <FaxMessage>
            <FaxID>long</FaxID>
            <TrackingNumber>string</TrackingNumber>
            <FaxType>int</FaxType>
            <FaxStatus>int</FaxStatus>
            <TransmitDate>dateTime</TransmitDate>
            <Viewed>boolean</Viewed>
            <PageCount>int</PageCount>
            <CostPerUnit>decimal</CostPerUnit>
            <FaxNumber>string</FaxNumber>
            <EmailAddress>string</EmailAddress>
            <SenderOrRecipient>string</SenderOrRecipient>
            <Subject>string</Subject>
            <RemoteNumber>string</RemoteNumber>
            <RemoteCSID>string</RemoteCSID>
            <RemoteANI>string</RemoteANI>
            <Destination>string</Destination>
            <ToName>string</ToName>
            <ToCompany>string</ToCompany>
            <ScheduledDate>dateTime</ScheduledDate>
            <BillingCode>string</BillingCode>
            <TransactStatus>int</TransactStatus>
            <IsSpam>boolean</IsSpam>
          </FaxMessage>
          <FaxMessage>
            <FaxID>long</FaxID>
            <TrackingNumber>string</TrackingNumber>
            <FaxType>int</FaxType>
            <FaxStatus>int</FaxStatus>
            <TransmitDate>dateTime</TransmitDate>
            <Viewed>boolean</Viewed>
            <PageCount>int</PageCount>
            <CostPerUnit>decimal</CostPerUnit>
            <FaxNumber>string</FaxNumber>
            <EmailAddress>string</EmailAddress>
            <SenderOrRecipient>string</SenderOrRecipient>
            <Subject>string</Subject>
            <RemoteNumber>string</RemoteNumber>
            <RemoteCSID>string</RemoteCSID>
            <RemoteANI>string</RemoteANI>
            <Destination>string</Destination>
            <ToName>string</ToName>
            <ToCompany>string</ToCompany>
            <ScheduledDate>dateTime</ScheduledDate>
            <BillingCode>string</BillingCode>
            <TransactStatus>int</TransactStatus>
            <IsSpam>boolean</IsSpam>
          </FaxMessage>
        </Items>
      </ListOutboundMessagesResult>
    </ListOutboundMessagesResponse>
  </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>
    <ListOutboundMessages xmlns="http://wsf.metrofax.com/webservices">
      <loginId>string</loginId>
      <password>string</password>
      <startDate>string</startDate>
      <endDate>string</endDate>
      <filter>string</filter>
      <sortColumns>string</sortColumns>
      <startRecord>int</startRecord>
      <maxRecords>int</maxRecords>
      <faxNumbers>
        <string>string</string>
        <string>string</string>
      </faxNumbers>
    </ListOutboundMessages>
  </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>
    <ListOutboundMessagesResponse xmlns="http://wsf.metrofax.com/webservices">
      <ListOutboundMessagesResult>
        <ResultCode>int</ResultCode>
        <ErrorMessage>string</ErrorMessage>
        <TotalRecords>int</TotalRecords>
        <Count>int</Count>
        <Items>
          <FaxMessage>
            <FaxID>long</FaxID>
            <TrackingNumber>string</TrackingNumber>
            <FaxType>int</FaxType>
            <FaxStatus>int</FaxStatus>
            <TransmitDate>dateTime</TransmitDate>
            <Viewed>boolean</Viewed>
            <PageCount>int</PageCount>
            <CostPerUnit>decimal</CostPerUnit>
            <FaxNumber>string</FaxNumber>
            <EmailAddress>string</EmailAddress>
            <SenderOrRecipient>string</SenderOrRecipient>
            <Subject>string</Subject>
            <RemoteNumber>string</RemoteNumber>
            <RemoteCSID>string</RemoteCSID>
            <RemoteANI>string</RemoteANI>
            <Destination>string</Destination>
            <ToName>string</ToName>
            <ToCompany>string</ToCompany>
            <ScheduledDate>dateTime</ScheduledDate>
            <BillingCode>string</BillingCode>
            <TransactStatus>int</TransactStatus>
            <IsSpam>boolean</IsSpam>
          </FaxMessage>
          <FaxMessage>
            <FaxID>long</FaxID>
            <TrackingNumber>string</TrackingNumber>
            <FaxType>int</FaxType>
            <FaxStatus>int</FaxStatus>
            <TransmitDate>dateTime</TransmitDate>
            <Viewed>boolean</Viewed>
            <PageCount>int</PageCount>
            <CostPerUnit>decimal</CostPerUnit>
            <FaxNumber>string</FaxNumber>
            <EmailAddress>string</EmailAddress>
            <SenderOrRecipient>string</SenderOrRecipient>
            <Subject>string</Subject>
            <RemoteNumber>string</RemoteNumber>
            <RemoteCSID>string</RemoteCSID>
            <RemoteANI>string</RemoteANI>
            <Destination>string</Destination>
            <ToName>string</ToName>
            <ToCompany>string</ToCompany>
            <ScheduledDate>dateTime</ScheduledDate>
            <BillingCode>string</BillingCode>
            <TransactStatus>int</TransactStatus>
            <IsSpam>boolean</IsSpam>
          </FaxMessage>
        </Items>
      </ListOutboundMessagesResult>
    </ListOutboundMessagesResponse>
  </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/ListOutboundMessages?loginId=string&password=string&startDate=string&endDate=string&filter=string&sortColumns=string&startRecord=string&maxRecords=string&faxNumbers=string&faxNumbers=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"?>
<SearchMessageResults xmlns="http://wsf.metrofax.com/webservices">
  <ResultCode>int</ResultCode>
  <ErrorMessage>string</ErrorMessage>
  <TotalRecords>int</TotalRecords>
  <Count>int</Count>
  <Items>
    <FaxMessage>
      <FaxID>long</FaxID>
      <TrackingNumber>string</TrackingNumber>
      <FaxType>int</FaxType>
      <FaxStatus>int</FaxStatus>
      <TransmitDate>dateTime</TransmitDate>
      <Viewed>boolean</Viewed>
      <PageCount>int</PageCount>
      <CostPerUnit>decimal</CostPerUnit>
      <FaxNumber>string</FaxNumber>
      <EmailAddress>string</EmailAddress>
      <SenderOrRecipient>string</SenderOrRecipient>
      <Subject>string</Subject>
      <RemoteNumber>string</RemoteNumber>
      <RemoteCSID>string</RemoteCSID>
      <RemoteANI>string</RemoteANI>
      <Destination>string</Destination>
      <ToName>string</ToName>
      <ToCompany>string</ToCompany>
      <ScheduledDate>dateTime</ScheduledDate>
      <BillingCode>string</BillingCode>
      <TransactStatus>int</TransactStatus>
      <IsSpam>boolean</IsSpam>
    </FaxMessage>
    <FaxMessage>
      <FaxID>long</FaxID>
      <TrackingNumber>string</TrackingNumber>
      <FaxType>int</FaxType>
      <FaxStatus>int</FaxStatus>
      <TransmitDate>dateTime</TransmitDate>
      <Viewed>boolean</Viewed>
      <PageCount>int</PageCount>
      <CostPerUnit>decimal</CostPerUnit>
      <FaxNumber>string</FaxNumber>
      <EmailAddress>string</EmailAddress>
      <SenderOrRecipient>string</SenderOrRecipient>
      <Subject>string</Subject>
      <RemoteNumber>string</RemoteNumber>
      <RemoteCSID>string</RemoteCSID>
      <RemoteANI>string</RemoteANI>
      <Destination>string</Destination>
      <ToName>string</ToName>
      <ToCompany>string</ToCompany>
      <ScheduledDate>dateTime</ScheduledDate>
      <BillingCode>string</BillingCode>
      <TransactStatus>int</TransactStatus>
      <IsSpam>boolean</IsSpam>
    </FaxMessage>
  </Items>
</SearchMessageResults>

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/ListOutboundMessages HTTP/1.1
Host: wsf.metrofax.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

loginId=string&password=string&startDate=string&endDate=string&filter=string&sortColumns=string&startRecord=string&maxRecords=string&faxNumbers=string&faxNumbers=string

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

<?xml version="1.0" encoding="utf-8"?>
<SearchMessageResults xmlns="http://wsf.metrofax.com/webservices">
  <ResultCode>int</ResultCode>
  <ErrorMessage>string</ErrorMessage>
  <TotalRecords>int</TotalRecords>
  <Count>int</Count>
  <Items>
    <FaxMessage>
      <FaxID>long</FaxID>
      <TrackingNumber>string</TrackingNumber>
      <FaxType>int</FaxType>
      <FaxStatus>int</FaxStatus>
      <TransmitDate>dateTime</TransmitDate>
      <Viewed>boolean</Viewed>
      <PageCount>int</PageCount>
      <CostPerUnit>decimal</CostPerUnit>
      <FaxNumber>string</FaxNumber>
      <EmailAddress>string</EmailAddress>
      <SenderOrRecipient>string</SenderOrRecipient>
      <Subject>string</Subject>
      <RemoteNumber>string</RemoteNumber>
      <RemoteCSID>string</RemoteCSID>
      <RemoteANI>string</RemoteANI>
      <Destination>string</Destination>
      <ToName>string</ToName>
      <ToCompany>string</ToCompany>
      <ScheduledDate>dateTime</ScheduledDate>
      <BillingCode>string</BillingCode>
      <TransactStatus>int</TransactStatus>
      <IsSpam>boolean</IsSpam>
    </FaxMessage>
    <FaxMessage>
      <FaxID>long</FaxID>
      <TrackingNumber>string</TrackingNumber>
      <FaxType>int</FaxType>
      <FaxStatus>int</FaxStatus>
      <TransmitDate>dateTime</TransmitDate>
      <Viewed>boolean</Viewed>
      <PageCount>int</PageCount>
      <CostPerUnit>decimal</CostPerUnit>
      <FaxNumber>string</FaxNumber>
      <EmailAddress>string</EmailAddress>
      <SenderOrRecipient>string</SenderOrRecipient>
      <Subject>string</Subject>
      <RemoteNumber>string</RemoteNumber>
      <RemoteCSID>string</RemoteCSID>
      <RemoteANI>string</RemoteANI>
      <Destination>string</Destination>
      <ToName>string</ToName>
      <ToCompany>string</ToCompany>
      <ScheduledDate>dateTime</ScheduledDate>
      <BillingCode>string</BillingCode>
      <TransactStatus>int</TransactStatus>
      <IsSpam>boolean</IsSpam>
    </FaxMessage>
  </Items>
</SearchMessageResults>