GetJobElementsRequest element

Article
04/25/2023

The required GetJobElementsRequest element requests information that is related to the job that the JobId element identifies.

Usage

<wscn:GetJobElementsRequest>
  child elements
</wscn:GetJobElementsRequest>

Attributes

There are no attributes.

Child elements

Element
JobId
RequestedElements

Parent elements

There are no parent elements.

Remarks

The WSD Scan Service must support the GetJobElementsRequest operation.

A client can call GetJobElementsRequest to determine the values of job-related elements for the job that JobId identifies. The WSD Scan Service must respond with a GetJobElementsResponse. The information that the Scan Service returns must fully comply with the scan job-related portion of the schema.

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.

GetJobElementsRequest might also return the following errors.

ClientErrorJobIdNotFound

The 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

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

Examples

The following code example requests the status of the scan job that Fault property 1 identifies.

<?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/GetJobElements
    </wsa:Action>
    <wsa:MessageID>uuid:UniqueMsgId</wsa:MessageID>
  </soap:Header>

  <soap:Body>
    <wscn:GetJobElements>
      <wscn:JobId>1</wscn:JobId>
      <wscn:RequestedElements>
        <wscn:Name>JobStatus</wscn:Name>
      </wscn:RequestedElements>
    </wscn:GetJobElements>
  </soap:Body>
</soap:Envelope>