共通インタフェース
クライアントからサーバにアクセスする場合、クライアントはリクエストURLに対してPOSTメソッドでデータを送信します（一部Cookieを利用する場合があります）。サーバからのレスポンスはXML形式で行われます。
HULFT-WebFileTransferのすべてのリクエストおよびレスポンスインタフェースの文字コードは、UTF-8を使用します。
HULFT-WebFileTransferのバージョンによっては、レスポンスインタフェースに本書に記載されていない項目が追加されている場合があります。Web APIを利用してアプリケーションを作成する際は、その点に注意してください。
一部のAPIについて、実行した際のレスポンスインタフェースのサンプルが提供媒体のTOOL\API_SAMPLE\API_RESPONSE\フォルダに格納されています。APIを使用する場合の参考にしてください。
本項では、各Web APIに共通のインタフェースについて解説します。
(1) リクエストURL
リクエストURLの書式を以下に例示します。
http(s)://Domain:xxxx/コンテキスト名/Web API名
- Domain
-
導入環境のドメイン名を設定します。
本マニュアル中では斜体で表示しています。
- xxxx
-
Apache Tomcatの接続先ポート番号を設定します。
本マニュアル中では斜体で表示しています。
- コンテキスト名
-
HULFT-WebFileTransferをアプリケーションサーバに導入した際のコンテキスト名を設定します。詳細は「HULFT-WebFileTransfer 導入マニュアル」を参照してください。
本マニュアル中では斜体で表示しています。
- Web API名
-
呼び出すWeb API名を設定します。
本マニュアル中では太字で表示しています。
(2) リクエストインタフェース
以下の項目は、すべてのリクエストインタフェースにおいて共通に使用します。
|
項目名 |
説明 |
文字 |
省略 |
省略値 |
||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
jsessionid |
セッションID J2EEに準拠します。 |
半角 |
○ |
Login APIのみ省略可、省略値はブランク |
||||||
|
client_type |
クライアント端末種別 クライアント端末の種別を指定します。
|
半角 |
○ |
|
||||||
|
language_type |
言語種別 クライアント端末の言語を指定します。
|
半角 |
○ |
0 |
||||||
|
session_validation |
セッション検証値 前回リクエスト時のレスポンスに含まれます。 session_validationを32バイトで指定します。 |
半角 |
× |
Login APIのみ省略可 省略値はブランク |
||||||
|
lines_per_page |
1ページあたりの表示行数（*1） 結果が複数件数となる場合、指定された件数分のデータをクライアントへ返却します。 指定範囲：1～999 |
半角 |
○ |
システム動作環境情報の「一覧表示件数」 |
||||||
|
current_page |
表示ページ番号 結果が複数件数となる場合、表示ページを指定します。 指定範囲：1～999 |
半角 |
○ |
1 |
||||||
|
update_flag |
更新フラグ 各種情報登録時の登録方法を指定します。
|
半角 |
○ |
false |
|
*1 |
: |
システム動作環境情報設定（RegisterSystemConfiguration）APIを使用する場合は、共通項目のlines_per_page（1ページあたりの表示行数）をリクエストパラメータに含めないでください。 |
Cookieとリクエストパラメータに同じ項目が設定されている場合、サーバはリクエストパラメータを優先して取得します。
リクエストパラメータの値がブランクの場合（リクエストパラメータ名は設定されているが値がない場合）、サーバはCookieの値を取得します。
(3) レスポンスインタフェース
以下の項目はすべてのレスポンスインタフェースにおいて共通で設定されます。
|
項目名 |
説明 |
備考 |
||||
|---|---|---|---|---|---|---|
|
api |
Web API名 Web API名が返却されます。 |
|
||||
|
jsessionid |
セッションID リクエストインタフェースのjsessionidが返却されます。 |
Cookieが利用可能なときはCookieにも格納します。Cookieが利用できないときはレスポンスのみで返却されます。 |
||||
|
session_validation |
セッション検証値 |
次回リクエスト時のリクエストパラメータsession_validationに指定します。 |
||||
|
return_code |
完了コード Web APIの完了コードが返却されます。
|
|
||||
|
detail_code |
詳細コード 完了コードがエラーの場合に返却されます。 システムコード等が返却されます。
|
|
||||
|
error_message |
エラーメッセージ 完了コードがエラーの場合、エラーメッセージが返却されます。 |
正常終了時はブランク |
||||
|
number_of_pages |
結果の総ページ数 単一結果の場合は1が返却されます。 データがない場合は0が返却されます。 |
|
||||
|
number_of_records |
結果の総件数 取得系APIでの結果の総件数が返却されます。 |
取得系APIでない場合はブランク |
||||
|
system_message |
システムメッセージ 警告等のユーザに注意を促すメッセージが返却されます。 |
|
サーバから情報を取得する際、結果の総ページ数（レスポンスインタフェースの「number_of_pages」）が1000以上になる場合があります。
しかし、取得するページ番号（リクエストインタフェースの「current_page」）には999までしか設定できないため、1000ページ以降の情報は取得できません。
総ページ数が1000以上になった場合は検索条件を変更してください。