Fax Entry Element - Multitech FaxFinder FF240-IP Developer's Manual

ELEMENTS
154 <!-- scheduled to send as soon as possible. -->
155 <!-- Format: %FT%T -->
156 <!-- required: no -->
157 <!-- value: string -->
158 <schedule_all_at>2008-08-07T20:30:00</schedule_all_at>
159 </schedule_fax>

Fax Entry Element

This element represents an actual fax that will be sent. Some of the elements are the same as elements provided
in schedule_fax. See the documentation above for an explanation of those fields.
1 <!-- Describes a Fax Entry -->
2 <fax_entry>
3 <!-- URL of this fax_entry -->
4 <!-- value: string -->
5 <fax_entry_url>https://172.16.0.13/ffws/v1/ofax/00000FD1/0000</fax_entry_url>
6 <!-- URL of scheduled_fax group to which this fax_entry is a part of -->
7 <!-- value: string -->
8 <fax_url>https://172.16.0.13/ffws/v1/ofax/00000FD1</fax_url>
9 <!-- Current state of this fax entry -->
10 <!-- Can be one of: -->
11 <!-- preprocessing-->
12 <!-- approval_pending -->
13 <!-- pending -->
14 <!-- sending -->
15 <!-- sent -->
16 <!-- aborted -->
17 <!-- failed -->
18 <!-- dead -->
19 <!-- value: string -->
20 <state>sent</state>
21 <!-- Human readable string describing the current status -->
22 <!-- value: string -->
23 <schedule_message>Successfully sent fax</schedule_message>
24 <!-- Human readable time representing the time -->
25 <!-- in the faxfinders time zone, when the fax -->
26 <!-- was created. -->
27 <!-- This value will be approximately the time when -->
28 <!-- the fax was scheduled. -->
29 <!-- value: string -->
30 <created>2009-01-30T04:43:26</created>
31 <!-- A contextual field which varies based on the -->
32 <!-- state. -->
33 <!-- When the fax is pending this field represents -->
34 <!-- the time when FaxFinder will try to send it. -->
35 <!-- When the fax is sending this field represents -->
36 <!-- the time when FaxFinder actually started sending it. -->
37 <!-- In any other case it is the time of completion. -->
38 <!-- value: string -->
39 <stime>2009-01-30T05:04:00</stime>
40 <!-- The number of unsuccessful tries that have already occurred -->
41 <!-- value: string -->
42 <try_number>1</try_number>
43 <!-- Sending Agent -->
44 <!-- value: string -->
45 <agent>FFWS</agent>
46 <!-- Fax Preview URL -->
47 <!-- value: string -->
49 FaxFinder Web Services API Developer Guide