Viewing Fax Entries - Multitech FaxFinder FF240-IP Developer's Manual

83 <approval_time></approval_time>
84 </fax_entry>
85 </response>

Viewing Fax Entries

Query
Parameters
HTTP Request
Line
HTTP Response
Status Codes
Example
1 GET /ffws/v1/ofax HTTP/1.1
2 content-type: application/xml
3 authorization: Basic YWRtaW46YWRtaW4=
4 -----------------------------------
5 HTTP/1.1 200 OK
6 content-type: application/xml
7 <?xml version="1.0" encoding="UTF-8"?>
8 <response>
9 <message>Success</message>
10 <fax_entry>
11 <fax_entry_url>https://192.168.2.1/ffws/v1/ofax/0000001B/0000</fax_entry_url>
12 <fax_url>https://192.168.2.1/ffws/v1/ofax/0000001B</fax_url>
13 <state>aborted</state>
14 <schedule_message>Fax aborted by user</schedule_message>
15 <created>2008-08-01 08:43:29</created>
16 <stime>2008-08-01 08:52:29</stime>
17 <try_number>1</try_number>
18 <agent>FFWS</agent>
19 <preview>https://192.168.2.1/ffws/v1/data/preview/0000001B-0000.pdf</preview>
20 <cover_page>
21 <url>https://192.168.2.1/ffws/v1/data/cover_pages/default.pdf</url>
22 <enabled>true</enabled>
23 <subject>Test Subject</subject>
FaxFinder Web Services API Developer Guide
all_users=true|false
An Admin level user can set this option to query all users instead of just faxes belonging
to the authenticated user.
complete_limit=LIMIT
Limit the number of completed faxes returned in a general query (/ffws/v1/ofax) to
LIMIT. By default the limit is 10. Faxes displayed in the completed list are (pre)viewable
and reschedulable.
class=pending|sending|complete
Retrieve faxes by class.
include_modem_info=true|false
Include modem level information in the response (init_time, connect_time, ...).
Requesting this information increases the response size. Modem information only
exists after the modem has completed at least one full attempt.
GET /ffws/v1/ofax HTTP/1.1
GET /ffws/v1/ofax/FAXKEY HTTP/1.1
GET /ffws/v1/ofax/FAXKEY/ENTRYKEY HTTP/1.1
200 OK Shows the fax entries.
FAXING
8