Technical information

USING XML-F
223
The application can either use the application-reference or the service-reference when referring to this request. This
permits the submitting application to issue status requests without having to wait or process a fax-submit-response
document prior to asking for status. In the event the fax-submit-response is never received, the application must use
the application-reference to get information on the request.
The fax-status comprises the following structure (this example is simplified):
fax-status
account (required)
id (required)
subid (zero or one)
mail-address (zero or one)
email-to (zero or more)
service-reference (must specify either
application-reference service or app ref)
command-reference (zero or one)
This is an example of a completed fax status document:
<?xml version="1.0"?>
<!DOCTYPE fax-status SYSTEM "fax-status.dtd">
<fax-status results-format="xml" report-type="full">
<account>
<id>
Filmore5455
</id>
<subid>
David Filmore
</subid>
<mail-address>
[e-mail]
</mail-address>
</account>
<service-reference>
1011
</service-reference>
<command-reference>
xxs234235s
</command-reference>
</fax-status>
Fax-status-response document
The fax-status-response document provides the detailed information about what happened (or is happening) to a fax
request on an XML-F service. The basic structure for the fax-status-response is as follows (this example is
simplified):
fax-status-response
request-results (required)
status (one of...) (required)
{short-status}
job-status (required)
{full-status}
job-status (required)
attempt-status (one or more)
recipient (required)
date (required)
csi (zero or one)
result (required)
short-message (required)
long-message (zero or one)
service-reference (required)
application-reference (zero or one)
command-reference (zero or one)