RetrieveImageRequest element

Article
05/01/2023

The required RetrieveImageRequest operation element contains the client's request to retrieve scan data from the device after a scan job has been created.

Usage

<wscn:RetrieveImageRequest>
  child elements
</wscn:RetrieveImageRequest>

Attributes

There are no attributes.

Child elements

Element
DocumentDescription
JobId
JobToken

Parent elements

There are no parent elements.

Remarks

The WSD Scan Service must support the RetrieveImageRequest operation element.

The Scan Service must validate the JobId and JobToken elements that the client provides to ensure that the job is valid and was created by the client that is requesting the retrieval. If the request is valid, the Scan Service must respond with a RetrieveImageResponse operation element.

This operation can return all of the common WSD Scan Service operation error codes. For more information about how to report errors, see WSD Scan Service Operation Error Reporting.

This operation might also return the following errors:

ClientErrorJobIdNotFoundThe scanner cannot find a job that matches the JobId value or the JobId value is not within the defined range.

Fault property Definition

[Code] soap:Sender

[Subcode] wscn:ClientErrorJobIdNotFound

[Reason] The specified JobId was not found.

[Detail] JobId: Incorrect JobId
ClientErrorNoImagesAvailableThe scanner does not have any more images available for the client to retrieve.

Fault property Definition

[Code] soap:Sender

[Subcode] wscn:ClientErrorNoImagesAvailable

[Reason] The server has no images available to acquire.

[Detail] None
ClientErrorInvalidJobTokenThe supplied JobToken value is not valid for the specified scan JobId.

Fault property Definition

[Code] soap:Sender

[Subcode] wscn:ClientErrorInvalidJobToken

[Reason] The JobToken parameter value is not valid with the JobId parameter.

[Detail] None
ClientErrorJobCancelled

Fault property Definition

[Code] soap:Sender

[Subcode] wscn:ClientErrorJobCancelled

[Reason] The current scan job has been canceled.

[Detail] None

Fault property	Definition
[Code]	soap:Sender
[Subcode]	wscn:ClientErrorJobIdNotFound
[Reason]	The specified JobId was not found.
[Detail]	JobId: Incorrect JobId

Fault property	Definition
[Code]	soap:Sender
[Subcode]	wscn:ClientErrorNoImagesAvailable
[Reason]	The server has no images available to acquire.
[Detail]	None

Fault property	Definition
[Code]	soap:Sender
[Subcode]	wscn:ClientErrorInvalidJobToken
[Reason]	The JobToken parameter value is not valid with the JobId parameter.
[Detail]	None

Fault property	Definition
[Code]	soap:Sender
[Subcode]	wscn:ClientErrorJobCancelled
[Reason]	The current scan job has been canceled.
[Detail]	None

Examples

The following code example shows a client request to retrieve image data for the job identified by 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>