Appendix B: Customization
Multi-Tech Systems, Inc.
FaxFinder Admin User Guide
105
General Status Codes
Be aware that other Status Codes that do not pertain specifically to the resource requested may be
returned.
See RFC 2616 for a listing of all possible codes.
Some FFWS general errors:
401 Unauthorized
Authorization required
415 Unsupported Media Type
Content-Type must be set to 'application/xml'
405 Method Not Allowed
The resource does not support that method
503 Service Unavailable
Temporary overloading
Schedule Fax Element
Most elements under schedule_fax are optional. If an element is left out then an appropriate default or
the empty string will be substituted.
<!-- Describes one or more faxes to send ->
<schedule_fax>
<!-- Cover page information -->
<cover_page>
<!-- URL of cover page on server to use -->
<!-- default: default.pdf -->
<!-- required: no -->
<!-- value: string -->
<url>https://192.168.2.1/ffws/v1/data/cover_pages/default.pdf</url>
<!-- Enable or disable the inclusion of a cover page -->
<!-- default: true -->
<!-- required: no -->
<!-- value: boolean -->
<enabled>true</enabled>
<!-- Subject added to subject field on cover page -->
<!-- default: "" -->
<!-- required: no -->
<!-- value: string -->
<subject>Test Subject</subject>
<!-- Message added to the comments field on cover page -->
<!-- Formatting is not preserved. Newlines and spaces -->
<!-- are reduced to a single space. -->
<!-- default: "" -->
<!-- required: no -->
<!-- value: string -->
<comments>Test Message</comments>
</cover_page>