FAX送信サービス サービスリファレンス
FaxQuery2
■概要
高度且つ、柔軟に送信トランザクションの詳細情報を取得するメソッドです。"Verb"と"VerbData"で問い合せします。
■記述形式
下記ページより、テストおよび記述形式を確認できます。
http://ws.interfax.net/dfs.asmx?op=FaxQuery2
■入力
| パラメータ | データ型 | 内容 | ||
|---|---|---|---|---|
| Username | String | ご登録のユーザID | ||
| Password | String | ご登録のパスワード | ||
| QueryForm | Structure | この構造体で戻り値を定義します。 | ||
| Subject | QueryCondition | Subjectで検索する際のプロパティ | ||
| Verb | Equals GreaterThan GreaterOrEqual LessThan LessOrEqual Like IncludedIn Between |
データ型は SQLOperatorEnum で宣言します。 | ||
| VerbData | String | 大文字・小文字を区別しません。 "IncludedIn"と"Between"には、","（カンマ）を区切り文字として使用します。 |
||
| FaxNumber | QueryCondition | 送信先FaxNumberで検索する際のプロパティ | ||
| Verb | Equals GreaterThan GreaterOrEqual LessThan LessOrEqual Like IncludedIn Between |
データ型は SQLOperatorEnum で宣言します。 | ||
| VerbData | String | "IncludedIn"と"Between"には、","（カンマ）を区切り文字として使用します。 | ||
| DateFrom | DateTime | 日付範囲で検索する際のSubmitTime（この日から） | ||
| DateTo | DateTime | 日付範囲で検索する際のSubmitTime（この日まで） | ||
| UserID | QueryCondition | Usernameで検索する際のプロパティ | ||
| Verb | Equals GreaterThan GreaterOrEqual LessThan LessOrEqual Like IncludedIn Between |
データ型は SQLOperatorEnum で宣言します。 | ||
| VerbData | String | 大文字・小文字を区別しません。 "IncludedIn"と"Between"には、","（カンマ）を区切り文字として使用します。 |
||
| ReplyAddress | QueryCondition | ReplyAddress（通知メールの送信先）で検索する際のプロパティ | ||
| Verb | Equals GreaterThan GreaterOrEqual LessThan LessOrEqual Like IncludedIn Between |
データ型は SQLOperatorEnum で宣言します。 | ||
| VerbData | String | 大文字・小文字を区別しません。 "IncludedIn"と"Between"には、","（カンマ）を区切り文字として使用します。 |
||
| TransactionID | QueryCondition | TransactionIDで検索する際のプロパティ | ||
| Verb | Equals GreaterThan GreaterOrEqual LessThan LessOrEqual Like IncludedIn Between |
データ型は SQLOperatorEnum で宣言します。 | ||
| VerbData | String | |||
| ParentTransactionID | QueryCondition | Parent TransactionIDで検索する際のプロパティ。複数宛先同時送信時に全トランザクションのクエリに適しています。 | ||
| Verb | Equals GreaterThan GreaterOrEqual LessThan LessOrEqual Like IncludedIn Between |
データ型は SQLOperatorEnum で宣言します。 | ||
| VerbData | String | "IncludedIn"と"Between"には、","（カンマ）を区切り文字として使用します。 | ||
| Status | QueryCondition | FAX送信の結果で検索する際のプロパティ。ステータス/エラーコード（FAX結果）を指定します。 | ||
| Verb | Equals GreaterThan GreaterOrEqual LessThan LessOrEqual Like IncludedIn Between |
データ型は SQLOperatorEnum で宣言します。 | ||
| VerbData | String | "IncludedIn"と"Between"には、","（カンマ）を区切り文字として使用します。 | ||
| ShowHiddenTransactions | Boolean | |||
| QueryControl | QueryControl | この構造体で戻り値を定義します。 | ||
| OnlyParents | Boolean | 複数宛先同時送信時のParent（親）トランザクションに限定 | ||
| NumOfResults | Integer | 取得するトランザクション数（システム制限値以内で指定します。） | ||
| StartingRecord | Integer | 開始トランザクション | ||
| OrderBy | TransactionID SubmitTime CompletionTime Status DestinationFax Subject PagesSent UserID ReplyEmail |
ソートする際のキー項目をしています。 データ型は OrderByColumnEnum で宣言します。 |
||
| AscOrderDirection | Boolean | 昇順でソートする | ||
| ReturnItems | Boolean | True=FaxItemsEx2を取得 False=FaxItemsEx2を取得しない |
||
| ReturnStats | Boolean | True=Statsを取得 False=Statsを取得しない |
||
■出力: FaxQuery2Result
| パラメータ | データ型 | 内容 | |
|---|---|---|---|
| ResultCode | Interger | このクエリ要求が成功した場合は、"0"が戻ります。 失敗時には、負の数値が戻ります。（FAX送信の結果ではなく、クエリ自体の結果です）戻り値の詳細は、Webサービス戻り値をご参照ください。 |
|
| FaxItems | Array | FaxItemEx2の配列 | |
| ParentTransactionID | Integer | リスト送信時のID（1件目のTransactionID） | |
| TransactionID | Integer | ||
| SubmitTime | DateTime | トランザクションが最初に送信された日時 | |
| PostponeTime | DateTime | 送信開始日時が指定された場合の日時（GMT） （指定の無い場合は、"0001-01-01T00:00:00.0000000-00:00"が返ります。） |
|
| CompletionTime | DateTime | トランザクションの終了日時 | |
| UserID | String | ||
| Contact | String | FAX送信時に指定したContact | |
| JobID | String | 現在使用不可です | |
| DestinationFax | String | 送信先FAX番号（FAX番号およびデータフォーマットの標準フォーマット） | |
| ReplyEmail | String | 通知メールが送られるメールアドレス。 未指定時は、アカウント管理Webのプロパティ "通知メールデフォルト送信先" が有効となります。 | |
| RemoteCSID | String | FAXを受信したFAX機のCSID（最大20半角文字） | |
| PagesSent | Short | 送信成功したページ数 | |
| Status | Integer | トランザクションのステータス （ステータス/エラーコード（FAX結果）をご参照ください。） |
|
| Duration | Integer | 送信時間（秒） | |
| Subject | String | 送信時に指定されたSubject（件名） | |
| PagesSubmitted | Short | InterFAXへ送信要求したドキュメントのページ数 | |
| SenderCSID | String | 送信者のCSID | |
| Priority | Short | FAX送信時、システムが割り当てた優先順位 | |
| Units | Decimal | 送信ページ数（ページあたり60秒を超えた場合は、超過分を含みます。）例: 1ページ送信で、送信時間が65秒の場合は、1.1。 | |
| CostPerUnit | Decimal | ページ単価 | |
| PageSize | String | 用紙サイズ A4/B4/Letter/Legal | |
| PageOrientation | String | 用紙方向 Portrait/Landscape | |
| PageResolution | String | 解像度 Standard（標準）/Fine（ファイン） | |
| RenderingQuality | String | 品質 Standard（白黒）/Fine（ハーフトーン） | |
| PageHeader | String | 指定されたヘッダ | |
| RetriesToPerform | Short | 指定されたリトライ回数 | |
| TrialsPerformed | Short | 実際におこなわれたリトライ回数 | |
| LocaleID | Integer | システム内部使用のみです | |
| GMTBias | Integer | システム内部使用のみです | |
| RetriesInterval | Integer | リトライ間隔 | |
| UserData | String | 現在使用不可です | |
| DeleteAfterUsage | String | アカウント管理WebのFAX送信プロパティで、「FAXイメージの削除」が選択され、FAX送信後にイメージが削除された場合は、"Y"、削除されていない場合は、"N"。 | |
| Mode | String | システムでの内部使用のみです | |
| NumOfTransactions | Integer | このトランザクションで使用された送信イメージファイル（TIFF）の数を表します。以下、例をご参考ください。 - FAXが一ヶ所に送信された場合： 1 - リスト送信等、複数の宛先に、同じ内容のFAXが送信された場合のParentTransaction： 送信先数（ChildTransaction数） |
|
| MessageID | String | 通知メールのMessageIDです。 | |
| Stats | Array | StatusCountの配列 | |
| Status | Integer | トランザクションのステータス （ステータス/エラーコード（FAX結果）をご参照ください。） |
|
| Count | Integer | 上記ステータスの件数 | |
