Wsf Web Service

Wsf

Click here for a complete list of operations.

GetFaxDetails

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

<?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>
    <GetFaxDetails xmlns="http://wsf.metrofax.com/webservices">
      <loginId>string</loginId>
      <password>string</password>
      <faxId>long</faxId>
    </GetFaxDetails>
  </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>
    <GetFaxDetailsResponse xmlns="http://wsf.metrofax.com/webservices">
      <GetFaxDetailsResult>
        <ResultCode>int</ResultCode>
        <ErrorMessage>string</ErrorMessage>
        <Count>int</Count>
        <Items>
          <FaxItem>
            <FaxID>long</FaxID>
            <FaxType>int</FaxType>
            <FaxStatus>int</FaxStatus>
            <TransmitDate>dateTime</TransmitDate>
            <Viewed>boolean</Viewed>
            <PageCount>int</PageCount>
            <CostPerUnit>decimal</CostPerUnit>
            <ImageSize>int</ImageSize>
            <FaxNumber>string</FaxNumber>
            <SenderOrRecipient>string</SenderOrRecipient>
            <Subject>string</Subject>
            <RemoteNumber>string</RemoteNumber>
            <RemoteCSID>string</RemoteCSID>
            <RemoteANI>string</RemoteANI>
            <Destination>string</Destination>
          </FaxItem>
          <FaxItem>
            <FaxID>long</FaxID>
            <FaxType>int</FaxType>
            <FaxStatus>int</FaxStatus>
            <TransmitDate>dateTime</TransmitDate>
            <Viewed>boolean</Viewed>
            <PageCount>int</PageCount>
            <CostPerUnit>decimal</CostPerUnit>
            <ImageSize>int</ImageSize>
            <FaxNumber>string</FaxNumber>
            <SenderOrRecipient>string</SenderOrRecipient>
            <Subject>string</Subject>
            <RemoteNumber>string</RemoteNumber>
            <RemoteCSID>string</RemoteCSID>
            <RemoteANI>string</RemoteANI>
            <Destination>string</Destination>
          </FaxItem>
        </Items>
      </GetFaxDetailsResult>
    </GetFaxDetailsResponse>
  </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>
    <GetFaxDetails xmlns="http://wsf.metrofax.com/webservices">
      <loginId>string</loginId>
      <password>string</password>
      <faxId>long</faxId>
    </GetFaxDetails>
  </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>
    <GetFaxDetailsResponse xmlns="http://wsf.metrofax.com/webservices">
      <GetFaxDetailsResult>
        <ResultCode>int</ResultCode>
        <ErrorMessage>string</ErrorMessage>
        <Count>int</Count>
        <Items>
          <FaxItem>
            <FaxID>long</FaxID>
            <FaxType>int</FaxType>
            <FaxStatus>int</FaxStatus>
            <TransmitDate>dateTime</TransmitDate>
            <Viewed>boolean</Viewed>
            <PageCount>int</PageCount>
            <CostPerUnit>decimal</CostPerUnit>
            <ImageSize>int</ImageSize>
            <FaxNumber>string</FaxNumber>
            <SenderOrRecipient>string</SenderOrRecipient>
            <Subject>string</Subject>
            <RemoteNumber>string</RemoteNumber>
            <RemoteCSID>string</RemoteCSID>
            <RemoteANI>string</RemoteANI>
            <Destination>string</Destination>
          </FaxItem>
          <FaxItem>
            <FaxID>long</FaxID>
            <FaxType>int</FaxType>
            <FaxStatus>int</FaxStatus>
            <TransmitDate>dateTime</TransmitDate>
            <Viewed>boolean</Viewed>
            <PageCount>int</PageCount>
            <CostPerUnit>decimal</CostPerUnit>
            <ImageSize>int</ImageSize>
            <FaxNumber>string</FaxNumber>
            <SenderOrRecipient>string</SenderOrRecipient>
            <Subject>string</Subject>
            <RemoteNumber>string</RemoteNumber>
            <RemoteCSID>string</RemoteCSID>
            <RemoteANI>string</RemoteANI>
            <Destination>string</Destination>
          </FaxItem>
        </Items>
      </GetFaxDetailsResult>
    </GetFaxDetailsResponse>
  </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/GetFaxDetails?loginId=string&password=string&faxId=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"?>
<SearchResults xmlns="http://wsf.metrofax.com/webservices">
  <ResultCode>int</ResultCode>
  <ErrorMessage>string</ErrorMessage>
  <Count>int</Count>
  <Items>
    <FaxItem>
      <FaxID>long</FaxID>
      <FaxType>int</FaxType>
      <FaxStatus>int</FaxStatus>
      <TransmitDate>dateTime</TransmitDate>
      <Viewed>boolean</Viewed>
      <PageCount>int</PageCount>
      <CostPerUnit>decimal</CostPerUnit>
      <ImageSize>int</ImageSize>
      <FaxNumber>string</FaxNumber>
      <SenderOrRecipient>string</SenderOrRecipient>
      <Subject>string</Subject>
      <RemoteNumber>string</RemoteNumber>
      <RemoteCSID>string</RemoteCSID>
      <RemoteANI>string</RemoteANI>
      <Destination>string</Destination>
    </FaxItem>
    <FaxItem>
      <FaxID>long</FaxID>
      <FaxType>int</FaxType>
      <FaxStatus>int</FaxStatus>
      <TransmitDate>dateTime</TransmitDate>
      <Viewed>boolean</Viewed>
      <PageCount>int</PageCount>
      <CostPerUnit>decimal</CostPerUnit>
      <ImageSize>int</ImageSize>
      <FaxNumber>string</FaxNumber>
      <SenderOrRecipient>string</SenderOrRecipient>
      <Subject>string</Subject>
      <RemoteNumber>string</RemoteNumber>
      <RemoteCSID>string</RemoteCSID>
      <RemoteANI>string</RemoteANI>
      <Destination>string</Destination>
    </FaxItem>
  </Items>
</SearchResults>

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

loginId=string&password=string&faxId=string

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

<?xml version="1.0" encoding="utf-8"?>
<SearchResults xmlns="http://wsf.metrofax.com/webservices">
  <ResultCode>int</ResultCode>
  <ErrorMessage>string</ErrorMessage>
  <Count>int</Count>
  <Items>
    <FaxItem>
      <FaxID>long</FaxID>
      <FaxType>int</FaxType>
      <FaxStatus>int</FaxStatus>
      <TransmitDate>dateTime</TransmitDate>
      <Viewed>boolean</Viewed>
      <PageCount>int</PageCount>
      <CostPerUnit>decimal</CostPerUnit>
      <ImageSize>int</ImageSize>
      <FaxNumber>string</FaxNumber>
      <SenderOrRecipient>string</SenderOrRecipient>
      <Subject>string</Subject>
      <RemoteNumber>string</RemoteNumber>
      <RemoteCSID>string</RemoteCSID>
      <RemoteANI>string</RemoteANI>
      <Destination>string</Destination>
    </FaxItem>
    <FaxItem>
      <FaxID>long</FaxID>
      <FaxType>int</FaxType>
      <FaxStatus>int</FaxStatus>
      <TransmitDate>dateTime</TransmitDate>
      <Viewed>boolean</Viewed>
      <PageCount>int</PageCount>
      <CostPerUnit>decimal</CostPerUnit>
      <ImageSize>int</ImageSize>
      <FaxNumber>string</FaxNumber>
      <SenderOrRecipient>string</SenderOrRecipient>
      <Subject>string</Subject>
      <RemoteNumber>string</RemoteNumber>
      <RemoteCSID>string</RemoteCSID>
      <RemoteANI>string</RemoteANI>
      <Destination>string</Destination>
    </FaxItem>
  </Items>
</SearchResults>