FaxStatusEx
Description
[Retained for backward-compatibility; replaced by FaxQuery]
Note that this method is rate-limited, as defined under System Limitations
Formal Definition
https://ws.interfax.net/dfs.asmx?op=FaxStatusEx
Input
| Name | Type | Comments |
|---|---|---|
| Username | String | As provided during registration |
| Password | String | As provided during registration |
| LastTransactionID | Integer | Only messages with TransactionID smaller than this parameter will be returned. For all transactions – use 99999999.This feature enables to obtain the latest, most interesting, transactions in a very short time and displays it. Afterwards, more data may be obtained concurrently with display of previous data. |
| MaxItems | Integer | Maximum number of FaxItem elements to be returned. |
Output
| Name | Type | Comments |
|---|---|---|
| TotalCount | Integer | An output parameter – total number of transactions for this user (regardless of number of transactionsn returned). |
| ListSize | Integer | An output parameter – total number of transactions actually returned by the query (size of FaxItems array). |
| ResultCode | Integer | 0= OK; less than 0 = Error, see Appendix A |
| FaxItems | Array | Array of FaxItemEx |
FaxItem Definition
| Name | Type | Comments |
|---|---|---|
| ParentTransactionID | Integer | In case of a Broadcast – the ID of the 1st item |
| TransactionID | Integer | |
| SubmitTime | DateTime | Time when the transaction was originally submitted by the client |
| PostponeTime | DateTime | Time to which transmission was scheduled the transmission. Returns '0000-00-00'if not postponed |
| CompletionTime | DateTime | End time of last of all transmission attempts |
| UserID | String | |
| Contact | String | The text which was inserted into the Contacts property upon submission of the fax with method SendfaxEx_2. |
| JobID | String | Reserved for future use |
| DestinationFax | String | The fax number in a canonical format (see Appendix B) |
| ReplyEmail | String | The E-mail address to which a confirmation message is to be sent |
| RemoteCSID | String | Receiving party CSID (up to 20 characters). |
| PagesSent | Short | Number of successfully sent pages. |
| Status | Integer | Fax status. 0= OK; greater than 0 = Error (See Interfax Error Codes) |
| Duration | Integer | Transmission time in seconds. |
| Subject | String | Original value as submitted. |
| PagesSubmitted | Short | Number of pages originally submitted. |
| SenderCSID | String | CSID of calling party |
| Priority | Short | Reserved for future use |
| Units | Decimal | Number of units to be billed (pages or tenths of minutes) |
| CostPerUnit | Decimal | Monetary units, in account currency |
| PageSize | String | A4, Letter, Legal, or B4 |
| PageOrientation | String | Portrait or Landscape |
| PageResolution | String | Standard or Fine |
| RenderingQuality | String | Standard (optimize for black & white) or Fine (optimize for greyscale) |
| PageHeader | String | Reserved for future use |
| RetriesToPerform | Short | Reserved for future use |
| TrialsPerformed | Short | Reserved for future use |