Élément RetrieveImageRequest

Article
02/02/2024

L’élément d’opération RetrieveImageRequest requis contient la demande du client de récupérer des données d’analyse à partir de l’appareil après la création d’un travail d’analyse.

Utilisation

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

Attributs

Il n’y a pas d’attributs.

Éléments enfants

Élément
DocumentDescription
JobId
JobToken

Éléments parents

Il n’y a pas d’éléments parents.

Remarques

Le service d’analyse WSD doit prendre en charge l’élément d’opération RetrieveImageRequest .

Le service d’analyse doit valider les éléments JobId et JobToken que le client fournit pour s’assurer que le travail est valide et a été créé par le client qui demande la récupération. Si la demande est valide, le service d’analyse doit répondre avec un élément d’opération RetrieveImageResponse .

Cette opération peut retourner tous les codes d’erreur courants du service d’analyse WSD. Pour plus d’informations sur la façon de signaler des erreurs, consultez Rapport d’erreurs des opérations du service d’analyse WSD.

Cette opération peut également retourner les erreurs suivantes :

ClientErrorJobIdNotFoundLe scanneur ne peut pas trouver un travail qui correspond à la valeur JobId ou la valeur JobId ne se trouve pas dans la plage définie.

Propriété Fault Définition

[Code] soap :Sender

[Sous-code] wscn :ClientErrorJobIdNotFound

[Motif] Le JobId spécifié est introuvable.

[Détail] JobId : JobId incorrect
ClientErrorNoImagesAvailableLe scanneur ne dispose plus d’images que le client peut récupérer.

Propriété Fault Définition

[Code] soap :Sender

[Sous-code] wscn :ClientErrorNoImagesAvailable

[Motif] Le serveur n’a aucune image disponible à acquérir.

[Détail] None

ClientErrorInvalidJobTokenLa valeur JobToken fournie n’est pas valide pour le JobId d’analyse spécifié.

Propriété Fault	Définition
[Code]	soap :Sender
[Sous-code]	wscn :ClientErrorInvalidJobToken
[Motif]	La valeur du paramètre JobToken n’est pas valide avec le paramètre JobId.
[Détail]	None

ClientErrorJobCancelled

Propriété Fault Définition

[Code] soap :Sender

[Sous-code] wscn :ClientErrorJobCancelled

[Motif] Le travail d’analyse actuel a été annulé.

[Détail] None

Exemples

L’exemple de code suivant montre une demande de client pour récupérer des données d’image pour le travail identifié par 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>

Voir aussi

DocumentDescription

JobId

JobToken

RetrieveImageResponse

Partager via