RetrieveImageRequest 要素
必須の RetrieveImageRequest 操作要素には、スキャン ジョブの作成後にデバイスからスキャン データを取得するというクライアントの要求が含まれています。
使用方法
<wscn:RetrieveImageRequest>
child elements
</wscn:RetrieveImageRequest>
属性
属性はありません。
子要素
| 要素 |
|---|
| DocumentDescription |
| JobId |
| JobToken |
親要素
親要素は存在しません。
解説
WSD スキャン サービスは、RetrieveImageRequest 操作要素に対応している必要があります。
スキャン サービスはジョブが有効であり、取得を要求しているクライアントによって作成されたことを確認するために、クライアントが提供する JobId 要素と JobToken 要素を検証する必要があります。 要求が有効な場合、スキャン サービスは RetrieveImageResponse 操作要素で応答する必要があります。
この操作は、すべての一般的な WSD スキャン サービス操作エラー コードを返します。 エラーを報告する方法の詳細は、「WSD スキャン サービス操作エラー報告」を参照してください。
この操作では、次のエラーが返される場合もあります。
ClientErrorJobIdNotFoundスキャナーで JobId 値に一致するジョブが見つからないか、JobId 値が定義済みの範囲内にありません。
Fault プロパティ Definition [コード] soap:Sender [サブコード] wscn:ClientErrorJobIdNotFound [理由] 指定した JobId が見つかりませんでした。 [詳細] JobId: JobId が正しくありません ClientErrorNoImagesAvailableスキャナーには、クライアントが取得できるイメージがありません。
Fault プロパティ Definition [コード] soap:Sender [サブコード] wscn:ClientErrorNoImagesAvailable [理由] サーバーには、取得できるイメージがありません。 [詳細] なし ClientErrorInvalidJobToken指定された JobToken 値が、指定されたスキャン JobId に対して無効です。
Fault プロパティ Definition [コード] soap:Sender [サブコード] wscn:ClientErrorInvalidJobToken [理由] JobToken パラメーターの値は、JobId パラメーターでは無効です。 [詳細] なし ClientErrorJobCancelled
Fault プロパティ Definition [コード] soap:Sender [サブコード] wscn:ClientErrorJobCancelled [理由] 現在のスキャン ジョブは取り消されました。 [詳細] なし
例
次のコード例は、JobId 1 で識別されるジョブのイメージ データを取得するクライアント要求を示しています。
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="https://www.w3.org/2003/05/soap-envelope"
xmlns:wsa="https://schemas.xmlsoap.org/ws/2003/03/addressing"
xmlns:wscn="https://schemas.microsoft.com/windows/2006/01/wdp/scan"
soap:encodingStyle='https://www.w3.org/2002/12/soap-encoding' >
<soap:Header>
<wsa:To>AddressofScannerService</wsa:To>
<wsa:Action>
https://schemas.microsoft.com/windows/2006/01/wdp/scan/RetrieveImage
</wsa:Action>
<wsa:MessageID>uuid:UniqueMsgId</wsa:MessageID>
</soap:Header>
<soap:Body>
<wscn:RetrieveImageRequest>
<wscn:JobId>1</wscn:JobId>
<wscn:JobToken>Job9876TokenString</wscn:JobToken>
<wscn:DocumentDescription>
<wscn:DocumentName>Scan001.jpg</DocumentName>
</wscn:DocumentDescription>
</wscn:RetrieveImageRequest>
</soap:Body>
</soap:Envelope>