Appendix B - Customization; Web Services Api - Multitech FaxFinder FF130 Administrator User Manual

Appendix B – Customization

Web Services API

Introduction
Fax Finder Web Service (hereafter FFWS) provides an interface to x30 FaxFinders for client applications.
Client application can use FFWS for sending faxes, managing contacts and monitoring fax status.
This document provides examples which illustrate the HTTP/XML communication between FFWS and a
client. Examples are broken up by actions performed on a resource. Sample HTTP requests and
responses are provided along with status codes.
Authorization
All request requiring authorization must have the Authorization header set using Basic authentication. If
this is not set or the username or password are incorrect then "401 Unauthorized" is returned.
See RFC 2617 for implementation
HTTPS
The server supports HTTPS. Secure requests can be sent to the default HTTPS port 443.
Creating a new fax
A new fax is created by posting a request to /ffws/v1/ofax with a schedule_fax element in the body.
If the fax is scheduled successfully then a response element is returned with a list of scheduled fax
entries; where each fax entry corresponds with a recipient in the previously scheduled fax.
Attachments
Each file that you wish to attach as fax pages must be placed in an attachment element. An "inline"
attachment is an attachment with the contents of the file inserted into the content tag. Inline
attachments must be encoded using base64. The name of the attachment can usually be set to the
basename of the file unless that name is not unique among the attachments. The name is used primarily
for error responses, so if you would like to know the attachment which failed then it is important to
make this field unique. The content type of the attachment should be set to match the type of file being
transferred. For example, if you are attaching a PDF, then the content type should be set to
"application/pdf". It is important to properly set the type because this field is used when converting the
file into fax pages. No attempt is made to guess the content type on the server.
Optional Query Parameters:
None
HTTP Request line:
POST /ffws/v1/ofax HTTP/1.0
HTTP Response Status Codes:
201 Created
The fax has been created successfully.
400 Bad Request
Invalid request. The fax has not been scheduled. A more verbose message may
be provided in the response message if possible.
Multi-Tech Systems, Inc. FaxFinder Admin User Guide
93