Élément CreateScanJobRequest
L’opération requise CreateScanJobRequest prépare un périphérique de numérisation à numériser.
Utilisation
<wscn:CreateScanJobRequest>
child elements
</wscn:CreateScanJobRequest>
Attributs
Il n’y a pas d’attributs.
Valeur textuelle
Aucune
Éléments enfants
| Element |
|---|
| DestinationToken |
| ScanIdentifier |
| ScanTicket |
Éléments parents
Il n’y a pas d’éléments parents.
Notes
Le service de numérisation WSD doit prendre en charge l’opération CreateScanJobRequest.
L’opération CreateScanJobRequest est le principal mécanisme pour préparer un périphérique de numérisation à numériser les images disponibles. Cette opération peut être initiée de deux manières différentes. Chaque méthode enverra des arguments différents à CreateScanJobRequest. Les deux méthodes et arguments sont :
L’utilisateur sélectionne une destination et appuie sur le bouton de numérisation sur le périphérique. Dans cette méthode, le client envoie un CreateScanJobRequest avec les éléments enfants suivants :
L’élément ScanIdentifier que le service de numérisation renvoie au client via ScanAvailableEvent. Le service de numérisation doit vérifier cet identifiant pour s’assurer que le bon client demande la numérisation après que l’utilisateur a sélectionné la destination.
L’élément DestinationToken que le service de numérisation WSD renvoie au client lorsqu’il s’est abonné pour recevoir des événements ScanAvailableEvent. Le service de numérisation doit vérifier que le bon client demande la numérisation en vérifiant ce jeton.
Un élément ScanTicket pour contrôler le traitement de la numérisation. Les valeurs dans le ticket de numérisation sont les valeurs par défaut définies sur le client avant que l’utilisateur ne se rende sur le périphérique pour initier la numérisation.
L’utilisateur démarre une application sur le client et acquiert une image. Dans cette méthode, le client envoie CreateScanJobRequest avec seulement l’élément ScanTicket.
Certains éléments de la hiérarchie CreateScanJobRequest peuvent contenir l’attribut booléen MustHonor. Si MustHonor est présent et vrai, le service de numérisation WSD doit respecter l’élément demandé et sa valeur ou rejeter la demande de travail de numérisation. Si un élément non pris en charge n’a pas d’attribut MustHonor, ou si son attribut MustHonor est faux, le service de numérisation WSD doit l’ignorer. Si l’attribut MustHonor d’un élément pris en charge est faux, le service de numérisation WSD doit remplacer la valeur demandée par une valeur prise en charge.
Si le client fournit une combinaison conflictuelle d’éléments dans la demande de travail de numérisation (comme InputSource et Resolution), le service de numérisation WSD doit rejeter la demande de travail de numérisation si les éléments conflictuels ont une valeur d’attribut MustHonor égale à vrai.
Les éléments suivants peuvent avoir l’attribut MustHonor attribute: ColorProcessing, CompressionQualityFactor, ContentType, Exposure, FilmScanMode, ImagesToTransfer, InputSize, InputSource, MediaSides, Resolution, Rotation, Scaling, ScanRegionHeight, ScanRegionWidth, ScanRegionXOffset, et ScanRegionYOffset.
Cette opération peut renvoyer tous les codes d’erreur d’opération du service de numérisation WSD communs. Pour plus d’informations sur la manière de signaler les erreurs, veuillez consulter la section Rapport d’erreurs d’opération du service de numérisation WSD.
CreateScanJobRequest peut également retourner les erreurs suivantes :
ServerErrorNotAcceptingJobs Le serveur ne peut pas accepter un nouveau travail de numérisation. Cette erreur peut se produire parce que le scanner a été mis en mode service ou parce qu’il y a une condition d’intervention de l’utilisateur et que tous les tampons de mémoire ont été épuisés. Le client peut essayer à nouveau la demande non modifiée ultérieurement, en espérant que le serveur est débloqué et que le scanner accepte à nouveau les travaux.
Propriété Fault Définition [Code] soap :Receiver [Subcode] wscn:ServerErrorNotAcceptingJobs [Reason] Le service est temporairement bloqué et ne peut pas accepter de nouvelles demandes de travail ou de document. [Detail] Aucune ClientErrorFormatNotSupported Le scanner ne prend pas en charge la valeur Format fournie.
Propriété Fault Définition [Code] soap:Sender [Subcode] wscn:ClientErrorFormatNotSupported [Reason] La valeur du paramètre Format du document n’est pas prise en charge. [Detail] facultatif. Le service de numérisation peut renvoyer une liste des formats pris en charge. Les données de cet élément doivent être de type <wscn:FormatSupportedType>. ClientErrorInvalidScanIdentifier La valeur ScanIdentifier fournie n’est actuellement pas valide dans le périphérique de numérisation.
Propriété Fault Définition [Code] soap:Sender [Subcode] wscn:ClientErrorInvalidScanIdentifier [Reason] La valeur du paramètre ScanIdentifier n’est actuellement pas valide. [Detail] Aucune ClientErrorInvalidDestinationToken La valeur DestinationToken fournie n’est pas valide pour le périphérique de numérisation.
Propriété Fault Définition [Code] soap:Sender [Subcode] wscn:ClientErrorInvalidDestinationToken [Reason] La valeur du paramètre DestinationToken n’est actuellement pas valide. [Detail] Aucune ClientErrorNoImagesAvailable Le serveur ne peut pas accepter un nouveau travail de numérisation car il n’y a aucun média à numériser. Par exemple, cette erreur est générée lorsqu’un travail de numérisation est exécuté à partir du chargeur automatique de documents attaché au scanner, et que le chargeur est vide. Le client peut essayer à nouveau la demande non modifiée ultérieurement, en espérant que la condition a été résolue et que le scanner a maintenant des médias à numériser.
Propriété Fault Définition [Code] soap:Sender [Subcode] wscn:ClientErrorNoImagesAvailable [Reason] Le serveur n’a pas d’images disponibles à acquérir. [Detail] Aucune
Exemples
L’exemple de code suivant montre une demande de travail de numérisation lorsque la numérisation est initiée à partir du périphérique de numérisation.
<?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/CreateScanJob
</wsa:Action>
<wsa:MessageID>uuid:UniqueMsgId</wsa:MessageID>
</soap:Header>
<soap:Body>
<wscn:CreateScanJobRequest>
<wscn:ScanIdentifier>
uuid:12e7a983-1034-5428-d298-0016f11097fa
</wscn:ScanIdentifier>
<wscn:DestinationToken>
Dest1234TokenString
</wscn:DestinationToken>
<wscn:ScanTicket>
<wscn:JobDescription>
<wscn:JobName>Photo Scan</wscn:JobName>
<wscn:JobOriginatingUserName>RogerSmith</JobOriginatingUserName>
</wscn:JobDescription>
<wscn:DocumentParameters>
<wscn:Format>jfif</wscn:Format>
<wscn:CompressionQualityFactor>45</wscn:CompressionQualityFactor>
<wscn:InputSource>Platen</wscn:InputSource>
<wscn:ContentType>Auto</wscn:ContentType>
<wscn:InputSize>
<wscn:DocumentSizeAutoDetect>true</wscn:DocumentSizeAutoDetect>
</wscn:InputSize>
<wscn:Scaling wscn:MustHonor="1">
<wscn:ScalingWidth>125</wscn:ScalingWidth>
<wscn:ScalingHeight>125</wscn:ScalingHeight>
</wscn:Scaling>
<wscn:MediaSides>
<wscn:MediaFront>
<wscn:Resolution wscn:MustHonor="1">
<wscn:Width>300</wscn:Width>
<wscn:Height>300</wscn:Height>
</wscn:Resolution>
</wscn:MediaFront>
</wscn:MediaSides>
</wscn:DocumentParameters>
</wscn:ScanTicket>
</wscn:CreateScanJobRequest>
</soap:Body>
</soap:Envelope>
L’exemple de code suivant montre une demande de travail de numérisation lorsque la numérisation est initiée à partir d’une application sur le client.
<?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/CreateScanJob
</wsa:Action>
<wsa:MessageID>uuid:UniqueMsgId</wsa:MessageID>
</soap:Header>
<soap:Body>
<wscn:CreateScanJobRequest>
<wscn:ScanTicket>
<wscn:JobDescription>
<wscn:JobName>Application Scan</wscn:JobName>
<wscn:JobOriginatingUserName>RogerSmith</JobOriginatingUserName>
</wscn:JobDescription>
<wscn:DocumentParameters>
<wscn:Format>xps</wscn:Format>
<wscn:ImagesToTransfer>0</wscn:ImagesToTransfer>
<wscn:InputSource>ADF</wscn:InputSource>
<wscn:ContentType>Auto</wscn:ContentType>
<wscn:InputSize>
<wscn:DocumentSizeAutoDetect>true</wscn:DocumentSizeAutoDetect>
</wscn:InputSize>
<wscn:MediaSides>
<wscn:MediaFront>
<wscn:ColorProcessing>RGB48</wscn:ColorProcessing>
<wscn:Resolution>
<wscn:Width>1200</wscn:Width>
</wscn:Resolution>
</wscn:MediaFront>
</wscn:MediaSides>
</wscn:DocumentParameters>
<wscn:DocumentDescription>
<wscn:DocumentName>Scan001.jpg</DocumentName>
</wscn:DocumentDescription>
</wscn:ScanTicket>
</wscn:CreateScanJobRequest>
</soap:Body>
</soap:Envelope>