Wsf Web Service

Wsf

Click here for a complete list of operations.

SendFaxMessage

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

<?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>
    <SendFaxMessage xmlns="http://wsf.metrofax.com/webservices">
      <loginId>string</loginId>
      <password>string</password>
      <subject>string</subject>
      <message>string</message>
      <fromEmailAddress>string</fromEmailAddress>
      <recipients>
        <FaxRecipient>
          <FaxNumber>string</FaxNumber>
          <Name>string</Name>
          <Company>string</Company>
          <VoiceNumber>string</VoiceNumber>
        </FaxRecipient>
        <FaxRecipient>
          <FaxNumber>string</FaxNumber>
          <Name>string</Name>
          <Company>string</Company>
          <VoiceNumber>string</VoiceNumber>
        </FaxRecipient>
      </recipients>
      <attachments>
        <FileRef>
          <Id>string</Id>
        </FileRef>
        <FileRef>
          <Id>string</Id>
        </FileRef>
      </attachments>
      <coverPageInfo>
        <CoverPage>string</CoverPage>
        <FromName>string</FromName>
        <FromEmail>string</FromEmail>
        <FromAddress>string</FromAddress>
        <FromPhone>string</FromPhone>
        <FromWebsite>string</FromWebsite>
        <FromFaxNumber>string</FromFaxNumber>
        <NoteText>string</NoteText>
        <Subject>string</Subject>
        <FromCompany>string</FromCompany>
      </coverPageInfo>
      <scheduleDate>string</scheduleDate>
      <billingCode>string</billingCode>
    </SendFaxMessage>
  </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>
    <SendFaxMessageResponse xmlns="http://wsf.metrofax.com/webservices">
      <SendFaxMessageResult>
        <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>
      </SendFaxMessageResult>
    </SendFaxMessageResponse>
  </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>
    <SendFaxMessage xmlns="http://wsf.metrofax.com/webservices">
      <loginId>string</loginId>
      <password>string</password>
      <subject>string</subject>
      <message>string</message>
      <fromEmailAddress>string</fromEmailAddress>
      <recipients>
        <FaxRecipient>
          <FaxNumber>string</FaxNumber>
          <Name>string</Name>
          <Company>string</Company>
          <VoiceNumber>string</VoiceNumber>
        </FaxRecipient>
        <FaxRecipient>
          <FaxNumber>string</FaxNumber>
          <Name>string</Name>
          <Company>string</Company>
          <VoiceNumber>string</VoiceNumber>
        </FaxRecipient>
      </recipients>
      <attachments>
        <FileRef>
          <Id>string</Id>
        </FileRef>
        <FileRef>
          <Id>string</Id>
        </FileRef>
      </attachments>
      <coverPageInfo>
        <CoverPage>string</CoverPage>
        <FromName>string</FromName>
        <FromEmail>string</FromEmail>
        <FromAddress>string</FromAddress>
        <FromPhone>string</FromPhone>
        <FromWebsite>string</FromWebsite>
        <FromFaxNumber>string</FromFaxNumber>
        <NoteText>string</NoteText>
        <Subject>string</Subject>
        <FromCompany>string</FromCompany>
      </coverPageInfo>
      <scheduleDate>string</scheduleDate>
      <billingCode>string</billingCode>
    </SendFaxMessage>
  </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>
    <SendFaxMessageResponse xmlns="http://wsf.metrofax.com/webservices">
      <SendFaxMessageResult>
        <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>
      </SendFaxMessageResult>
    </SendFaxMessageResponse>
  </soap12:Body>
</soap12:Envelope>