Wsf Web Service

Wsf

Click here for a complete list of operations.

GetAccountInfo

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

<?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>
    <GetAccountInfo xmlns="http://wsf.metrofax.com/webservices">
      <loginId>string</loginId>
      <password>string</password>
    </GetAccountInfo>
  </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>
    <GetAccountInfoResponse xmlns="http://wsf.metrofax.com/webservices">
      <GetAccountInfoResult>
        <ResultCode>int</ResultCode>
        <ErrorMessage>string</ErrorMessage>
        <AccountDetails>
          <FaxNumber>string</FaxNumber>
          <PrimaryEmail>string</PrimaryEmail>
          <FaxNumberCity>string</FaxNumberCity>
          <FaxNumberState>string</FaxNumberState>
          <EmailNotificationTimeZoneIndex>int</EmailNotificationTimeZoneIndex>
          <ClientId>long</ClientId>
          <IntlFaxingEnabled>boolean</IntlFaxingEnabled>
          <SmsNotificationsEnabled>boolean</SmsNotificationsEnabled>
          <SmsNotifyInbound>boolean</SmsNotifyInbound>
          <SmsNotifyOutbound>boolean</SmsNotifyOutbound>
          <SmsPrimaryAddress>string</SmsPrimaryAddress>
          <EmailFaxFormat>string</EmailFaxFormat>
          <EmailSendConfirmSuccessful>boolean</EmailSendConfirmSuccessful>
          <EmailSendConfirmFailed>boolean</EmailSendConfirmFailed>
          <EmailReceiveIncludeXmitDetails>boolean</EmailReceiveIncludeXmitDetails>
          <EmailReceivePlainTextNotifications>boolean</EmailReceivePlainTextNotifications>
          <EmailReceiveFirstPagePreview>boolean</EmailReceiveFirstPagePreview>
          <EmailSendConfirmationIncludesSentFax>boolean</EmailSendConfirmationIncludesSentFax>
          <EmailSendConfirmationHasFirstPagePreview>boolean</EmailSendConfirmationHasFirstPagePreview>
          <EmailSendConfirmationInPlainText>boolean</EmailSendConfirmationInPlainText>
          <ReceivedFaxRouteType>string</ReceivedFaxRouteType>
          <AccountStatus>string</AccountStatus>
          <AccountName>string</AccountName>
          <AccountCompany>string</AccountCompany>
          <BillingCode>string</BillingCode>
          <CallingMaxAttempts>short</CallingMaxAttempts>
          <CallingTimeBetweenAttempts>short</CallingTimeBetweenAttempts>
          <HeaderEnabled>boolean</HeaderEnabled>
          <HeaderName>string</HeaderName>
          <HeaderNumber>string</HeaderNumber>
          <AdditionalEmailAddresses>
            <string>string</string>
            <string>string</string>
          </AdditionalEmailAddresses>
          <OnlineStorageDays>int</OnlineStorageDays>
          <CallerID>string</CallerID>
          <SecondaryBillingCode>string</SecondaryBillingCode>
        </AccountDetails>
      </GetAccountInfoResult>
    </GetAccountInfoResponse>
  </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>
    <GetAccountInfo xmlns="http://wsf.metrofax.com/webservices">
      <loginId>string</loginId>
      <password>string</password>
    </GetAccountInfo>
  </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>
    <GetAccountInfoResponse xmlns="http://wsf.metrofax.com/webservices">
      <GetAccountInfoResult>
        <ResultCode>int</ResultCode>
        <ErrorMessage>string</ErrorMessage>
        <AccountDetails>
          <FaxNumber>string</FaxNumber>
          <PrimaryEmail>string</PrimaryEmail>
          <FaxNumberCity>string</FaxNumberCity>
          <FaxNumberState>string</FaxNumberState>
          <EmailNotificationTimeZoneIndex>int</EmailNotificationTimeZoneIndex>
          <ClientId>long</ClientId>
          <IntlFaxingEnabled>boolean</IntlFaxingEnabled>
          <SmsNotificationsEnabled>boolean</SmsNotificationsEnabled>
          <SmsNotifyInbound>boolean</SmsNotifyInbound>
          <SmsNotifyOutbound>boolean</SmsNotifyOutbound>
          <SmsPrimaryAddress>string</SmsPrimaryAddress>
          <EmailFaxFormat>string</EmailFaxFormat>
          <EmailSendConfirmSuccessful>boolean</EmailSendConfirmSuccessful>
          <EmailSendConfirmFailed>boolean</EmailSendConfirmFailed>
          <EmailReceiveIncludeXmitDetails>boolean</EmailReceiveIncludeXmitDetails>
          <EmailReceivePlainTextNotifications>boolean</EmailReceivePlainTextNotifications>
          <EmailReceiveFirstPagePreview>boolean</EmailReceiveFirstPagePreview>
          <EmailSendConfirmationIncludesSentFax>boolean</EmailSendConfirmationIncludesSentFax>
          <EmailSendConfirmationHasFirstPagePreview>boolean</EmailSendConfirmationHasFirstPagePreview>
          <EmailSendConfirmationInPlainText>boolean</EmailSendConfirmationInPlainText>
          <ReceivedFaxRouteType>string</ReceivedFaxRouteType>
          <AccountStatus>string</AccountStatus>
          <AccountName>string</AccountName>
          <AccountCompany>string</AccountCompany>
          <BillingCode>string</BillingCode>
          <CallingMaxAttempts>short</CallingMaxAttempts>
          <CallingTimeBetweenAttempts>short</CallingTimeBetweenAttempts>
          <HeaderEnabled>boolean</HeaderEnabled>
          <HeaderName>string</HeaderName>
          <HeaderNumber>string</HeaderNumber>
          <AdditionalEmailAddresses>
            <string>string</string>
            <string>string</string>
          </AdditionalEmailAddresses>
          <OnlineStorageDays>int</OnlineStorageDays>
          <CallerID>string</CallerID>
          <SecondaryBillingCode>string</SecondaryBillingCode>
        </AccountDetails>
      </GetAccountInfoResult>
    </GetAccountInfoResponse>
  </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/GetAccountInfo?loginId=string&password=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"?>
<AccountInfo xmlns="http://wsf.metrofax.com/webservices">
  <ResultCode>int</ResultCode>
  <ErrorMessage>string</ErrorMessage>
  <AccountDetails>
    <FaxNumber>string</FaxNumber>
    <PrimaryEmail>string</PrimaryEmail>
    <FaxNumberCity>string</FaxNumberCity>
    <FaxNumberState>string</FaxNumberState>
    <EmailNotificationTimeZoneIndex>int</EmailNotificationTimeZoneIndex>
    <ClientId>long</ClientId>
    <IntlFaxingEnabled>boolean</IntlFaxingEnabled>
    <SmsNotificationsEnabled>boolean</SmsNotificationsEnabled>
    <SmsNotifyInbound>boolean</SmsNotifyInbound>
    <SmsNotifyOutbound>boolean</SmsNotifyOutbound>
    <SmsPrimaryAddress>string</SmsPrimaryAddress>
    <EmailFaxFormat>string</EmailFaxFormat>
    <EmailSendConfirmSuccessful>boolean</EmailSendConfirmSuccessful>
    <EmailSendConfirmFailed>boolean</EmailSendConfirmFailed>
    <EmailReceiveIncludeXmitDetails>boolean</EmailReceiveIncludeXmitDetails>
    <EmailReceivePlainTextNotifications>boolean</EmailReceivePlainTextNotifications>
    <EmailReceiveFirstPagePreview>boolean</EmailReceiveFirstPagePreview>
    <EmailSendConfirmationIncludesSentFax>boolean</EmailSendConfirmationIncludesSentFax>
    <EmailSendConfirmationHasFirstPagePreview>boolean</EmailSendConfirmationHasFirstPagePreview>
    <EmailSendConfirmationInPlainText>boolean</EmailSendConfirmationInPlainText>
    <ReceivedFaxRouteType>string</ReceivedFaxRouteType>
    <AccountStatus>string</AccountStatus>
    <AccountName>string</AccountName>
    <AccountCompany>string</AccountCompany>
    <BillingCode>string</BillingCode>
    <CallingMaxAttempts>short</CallingMaxAttempts>
    <CallingTimeBetweenAttempts>short</CallingTimeBetweenAttempts>
    <HeaderEnabled>boolean</HeaderEnabled>
    <HeaderName>string</HeaderName>
    <HeaderNumber>string</HeaderNumber>
    <AdditionalEmailAddresses>
      <string>string</string>
      <string>string</string>
    </AdditionalEmailAddresses>
    <OnlineStorageDays>int</OnlineStorageDays>
    <CallerID>string</CallerID>
    <SecondaryBillingCode>string</SecondaryBillingCode>
  </AccountDetails>
</AccountInfo>

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

loginId=string&password=string

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

<?xml version="1.0" encoding="utf-8"?>
<AccountInfo xmlns="http://wsf.metrofax.com/webservices">
  <ResultCode>int</ResultCode>
  <ErrorMessage>string</ErrorMessage>
  <AccountDetails>
    <FaxNumber>string</FaxNumber>
    <PrimaryEmail>string</PrimaryEmail>
    <FaxNumberCity>string</FaxNumberCity>
    <FaxNumberState>string</FaxNumberState>
    <EmailNotificationTimeZoneIndex>int</EmailNotificationTimeZoneIndex>
    <ClientId>long</ClientId>
    <IntlFaxingEnabled>boolean</IntlFaxingEnabled>
    <SmsNotificationsEnabled>boolean</SmsNotificationsEnabled>
    <SmsNotifyInbound>boolean</SmsNotifyInbound>
    <SmsNotifyOutbound>boolean</SmsNotifyOutbound>
    <SmsPrimaryAddress>string</SmsPrimaryAddress>
    <EmailFaxFormat>string</EmailFaxFormat>
    <EmailSendConfirmSuccessful>boolean</EmailSendConfirmSuccessful>
    <EmailSendConfirmFailed>boolean</EmailSendConfirmFailed>
    <EmailReceiveIncludeXmitDetails>boolean</EmailReceiveIncludeXmitDetails>
    <EmailReceivePlainTextNotifications>boolean</EmailReceivePlainTextNotifications>
    <EmailReceiveFirstPagePreview>boolean</EmailReceiveFirstPagePreview>
    <EmailSendConfirmationIncludesSentFax>boolean</EmailSendConfirmationIncludesSentFax>
    <EmailSendConfirmationHasFirstPagePreview>boolean</EmailSendConfirmationHasFirstPagePreview>
    <EmailSendConfirmationInPlainText>boolean</EmailSendConfirmationInPlainText>
    <ReceivedFaxRouteType>string</ReceivedFaxRouteType>
    <AccountStatus>string</AccountStatus>
    <AccountName>string</AccountName>
    <AccountCompany>string</AccountCompany>
    <BillingCode>string</BillingCode>
    <CallingMaxAttempts>short</CallingMaxAttempts>
    <CallingTimeBetweenAttempts>short</CallingTimeBetweenAttempts>
    <HeaderEnabled>boolean</HeaderEnabled>
    <HeaderName>string</HeaderName>
    <HeaderNumber>string</HeaderNumber>
    <AdditionalEmailAddresses>
      <string>string</string>
      <string>string</string>
    </AdditionalEmailAddresses>
    <OnlineStorageDays>int</OnlineStorageDays>
    <CallerID>string</CallerID>
    <SecondaryBillingCode>string</SecondaryBillingCode>
  </AccountDetails>
</AccountInfo>