レスポンス (GET)
CloudPRNTにおけるクライアントからのGETリクエストに対する、サーバーからのレスポンスの設定項目は以下を参考にしてください。
レスポンスヘッダー |
レスポンスボディ |
|---|---|
HTTPステータスコード、CloudPRNTで定義されたカスタムヘッダー(オプション) |
クライアントから指定されたメディアタイプでエンコードされた印刷ジョブのためのコンテンツデータ (JSONデータは含みません) |
サーバーは下記値のうち一つの適切なHTTPレスポンスステータスコードを設定してください。
200 (OK) - 操作が成功し、印刷ジョブデータを期待どおり返した
404 (not found) - 利用可能な印刷データが無い
415 (unsupported media type) - サーバーがサポートしないメディアタイプの要求であった
200 以外のエラーステータスコードの場合、レスポンス body は無視されます。
なお、サーバーからのGET応答に関する各HTTPレスポンスステータスコードを受け取り後のプリンターの動作例は下記となります。
ステータスコード |
プリンター動作 |
|---|---|
200 |
印刷完了後、codeパラメーターに200 OKを付加して 印刷ジョブ完了確認 (DELETE) を発行します。 |
200以外 |
codeパラメーターにエラーコード520(もしくは521)を付加して 印刷ジョブ完了確認 (DELETE) を発行します。 |
レスポンスヘッダー
印刷ジョブがtext/plain, image/png, image/jpegのいずれかのメディアタイプのとき、サーバーは印刷ジョブに対して、下記拡張制御オプションを設定することができます。
カスタムレスポンスヘッダーと対応機種一覧:
Header Field Name |
IFBD-HI01X/HI02X |
mC-Print2/3 |
TSP100IV |
TSP100IV SK |
mC-Label3 |
|---|---|---|---|---|---|
X-Star-Buzzerstartpattern |
1.1.0以上 |
1.2以上 |
1.0以上 |
2.0以上 |
1.0以上 |
X-Star-Buzzerendpattern |
1.1.0以上 |
1.2以上 |
1.0以上 |
2.0以上 |
1.0以上 |
X-Star-Cut |
1.4.0以上 |
1.2以上 |
1.0以上 |
2.0以上 |
1.0以上 |
X-Star-ImageDitherPattern |
1.1.0以上 |
1.2以上 |
1.0以上 |
2.0以上 |
1.0以上 |
X-Star-CashDrawer |
1.1.0以上 |
1.2以上 |
1.0以上 |
2.0以上 |
1.0以上 |
X-Star-UseDeviceCommand |
1.8.0以上 |
3.5以上 |
1.0以上 |
2.0以上 |
1.0以上 |
X-Star-PaperPresentStatusControl |
1.9.0以上(*1) |
利用不可 |
利用不可 |
2.0以上 |
1.0以上 |
X-Star-HoldPrintControl |
1.9.0以上(*1) |
利用不可 |
利用不可 |
2.0以上 |
1.0以上 |
(*1) Only available with TSP650IISK printer.
カスタムレスポンスヘッダー一覧:
Header Field Name |
Example |
Description |
|---|---|---|
X-Star-Buzzerstartpattern |
X-Star-Buzzerstartpattern: 1 |
送信したジョブを印刷する前に、ブザーを指定回数分鳴らします。
指定可能範囲: 1 ~ 3
(MCS10では回数指定は機能しませんので、1回を指定してください)
|
X-Star-Buzzerendpattern |
X-Star-Buzzerendpattern: 1 |
送信したジョブを印刷したあとに、ブザーを指定回数分鳴らします。
指定可能範囲: 1 ~ 3
(MCS10では回数指定は機能しませんので、1回を指定してください)
|
X-Star-Cut |
X-Star-Cut: full; feed=true |
印刷後のカット動作の挙動を指定します。
指定値: full, partial, none.
feed オプションは true か false で設定します。
(指定されない場合 true になります)
|
X-Star-ImageDitherPattern |
X-Star-ImageDitherPattern: none |
画像イメージを印刷する場合のディザリング適用の有無を指定します。
(指定しない場合 fs となります)
指定値:
* none - 適用無し
* fs - Floyd Steinberg 誤差拡散適用
|
X-Star-CashDrawer |
X-Star-CashDrawer: start |
送信したジョブの印刷の前後におけるキャッシュドロワーオープンの設定をします。
指定値:
* none - ドロアーを利用しない
* start - 印刷前に実行
* end - 印刷後に実行
|
X-Star-UseDeviceCommand |
X-Star-UseDeviceCommand: true |
画像を印刷する場合のディザリング設定を除いたレスポンスヘッダーの機能について、application/vnd.star.xxxメディアタイプの印刷ジョブに対する適用の有無を指定します。
指定値: true, false(デフォルト)
備考: カット/キャッシュドロワー/ブザー動作は、印刷ジョブにこれらのコマンドが含まれている場合二重で実行されます。
そのため、もし本機能を有効にして利用する場合は二重実行とならないよう注意してください。
|
X-Star-PaperPresentStatusControl |
X-Star-PaperPresentStatusControl: default |
ジョブ印刷時に、排出口の用紙有無のステータス通知をクライアントに送信するかしないかの設定をするためのフラグを指定します。
このオプションを指定した場合、clientActionのPaperPresentStatusControlの値は一度無視されます。
指定値:
* default - 次の印刷ジョブを送信した後、 クライアントの現在設定値に従って用紙保持制御ステータスが通知されます(または通知されません)。
* valid - 次の印刷ジョブを送信した後、プリンターASBステータスの7番目の値にて用紙保持制御ステータスが通知されます。
* invalid - 次の印刷ジョブを送信した後、用紙保持制御ステータスは通知されません。
|
X-Star-HoldPrintControl |
X-Star-HoldPrintControl: invalid |
ジョブ印刷時に、デバイスによる用紙保持制御の有効無効を設定をするためのフラグを指定します。
このオプションを指定した場合、clientActionのHoldPrintControlの値は一度無視されます。
指定値:
* default - 次の印刷ジョブを送信した後、クライアントの現在設定値に従って用紙保持制御が有効になります(または無効になります)。
* valid - 次の印刷ジョブを送信した後、デバイスによる用紙保持制御を有効にします。
* invalid - 次の印刷ジョブを送信した後、デバイスによる用紙保持制御を無効にします。
このオプションの指定は、invalidを推奨します。
|