各APIのパラメータと返却データは、ユニットIDなどの識別子を使って関連付けられています。
本記事では、各APIに指定するパラメータと、その取得方法について解説します。
処理：読取登録
| パラメータ | 説明 |
|
送信ファイル （files）* |
ファイルは一度に複数を指定できます。 curlコマンドで複数ファイルを指定する場合は、ファイルの数だけ -F "files=@{ファイル名}" を追加します。 |
|
利用モデルの名称 （model） |
DX Suite 非定型モデル仕様書を参照してください ※本人確認書類モデルは帳票の仕分け処理を実行するため、他の非定型モデルと比較して処理時間が長くなります |
|
読取クラス名 （classes） |
DX Suite 非定型モデル仕様書を参照してください |
|
部署ID （departmentId） |
* 必須項目
処理：読取結果取得
| パラメータ | 確認の仕方 |
|
受付ID （receptionId） |
読取登録API、または受付情報取得APIのレスポンスから取得ください。 |
処理：受付情報取得
| パラメータ | 確認の仕方 |
|
部署ID （departmentId） |
|
|
非定型モデル名 （model） |
DX Suite 非定型モデル仕様書を参照してください |
|
読取処理状態 （status） |
読取処理のステータスを数値で指定します。 1: 処理中 2: 読取完了 3: 読取失敗 ※全ファイルがエラーの場合、3: 読取失敗となります。 |
|
取得件数 （limit） |
取得するデータの最大件数を指定します。 |
|
取得開始位置 （offset） |
条件に一致したデータのうち、何件目から取得を開始するかを数値で指定します。 |
|
受付日時From （receptionDateTimeFrom） |
以下の書式に従って日付範囲の開始日時を指定ください。 ・YYYY-MM-DDTHH:MM:SSZ または YYYY-MM-DD ※ISO8601に準拠 ・「YYYY-MM-DD」の後ろの「T」は固定値です。 ・「HH:MM:SS」の後ろの「Z」はタイムゾーン(UTC)で省略可能です。 |
|
受付日時To （receptionDateTimeTo） |
日付範囲の終了日時を、以下の書式に従って指定してください。 YYYY-MM-DDTHH:MM:SSZ または YYYY-MM-DD（※ISO 8601形式に準拠） 「T」 は YYYY-MM-DD の直後に固定で挿入してください。 「Z」 はタイムゾーン（UTC）を示します。省略可能です。 |
処理：データ削除
| パラメータ | 確認の仕方 |
|
受付ID （receptionId）* |
読取登録API、または受付情報取得APIのレスポンスから取得ください。 |
* 必須項目