elemento CreateScanJobRequest
La operación CreateScanJobRequest necesaria prepara un dispositivo de examen para escanear.
Uso
<wscn:CreateScanJobRequest>
child elements
</wscn:CreateScanJobRequest>
Atributos
No hay atributos.
Valor de texto
None
Elementos secundarios
| Elemento |
|---|
| DestinationToken |
| ScanIdentifier |
| ScanTicket |
Elementos primarios
No hay elementos primarios.
Comentarios
El servicio de examen de WSD debe admitir la operación CreateScanJobRequest.
La operación CreateScanJobRequest es el mecanismo principal para prepara un dispositivo de examen para escanear las imágenes que estén disponibles. Esta operación se puede iniciar en dos métodos diferentes. Cada método enviará argumentos diferentes a CreateScanJobRequest. Los dos métodos y argumentos son:
El usuario selecciona un destino e inserta el botón para escanear en el dispositivo. En este método, el cliente envía un CreateScanJobRequest con los siguientes elementos secundarios:
El elemento ScanIdentifier que el servicio de examen devuelve al cliente a través de ScanAvailableEvent. El servicio de examen debe comprobar este identificador para asegurarse de que el cliente correcto solicita el examen después de que el usuario haya seleccionado el destino.
El elemento DestinationToken que el servicio de examen de WSD devuelve al cliente cuando se suscribió para recibir eventos ScanAvailableEvent. El servicio de examen debe comprobar este identificador para asegurarse de que el cliente correcto solicita el examen comprobando este token.
Un elemento ScanTicket para controlar el procesamiento del examen. Los valores en el vale de examen son los valores predeterminados que se establecen en el cliente antes de que el usuario acceda al dispositivo para iniciar el escaneo.
El usuario inicia una aplicación en el cliente y adquiere una imagen. En este método, el cliente envía un CreateScanJobRequest solo con el elemento ScanTicket:
Algunos elementos de la jerarquía CreateScanJobRequest pueden contener el atributo booleano MustHonor. Si MustHonor está presente y es true, el servicio de examen de WSD debe respetar el elemento solicitado y su valor o rechazar la solicitud de trabajo de escaneo. Si un elemento no admitido no tiene un atributo MustHonor, o si su atributo MustHonor es false, el servicio de examen de WSD debe omitirlo. Si el atributo MustHonor de un elemento admitido es false, el servicio de examen de WSD debe sustituir el valor solicitado por uno compatible.
Si el cliente proporciona una combinación conflictiva de elementos en la solicitud de trabajo de examen (como InputSource y Resolution), el servicio de examen WSD debe rechazar la solicitud de trabajo de examen si los elementos en conflicto tienen un valor de atributo MustHonor de true.
Los siguientes elementos pueden tener el atributo MustHonor: ColorProcessing, CompressionQualityFactor, ContentType, Exposure, FilmScanMode, ImagesToTransfer, InputSize, InputSource, MediaSides, Resolution, Rotation, Scaling, ScanRegionHeight, ScanRegionWidth, ScanRegionXOffset, y ScanRegionYOffset.
Esta operación puede devolver todos los códigos de error de operaciones de servicio de examen de WSD comunes. Para obtener más información sobre cómo notificar errores, consulte Informe de errores de la operación del servicio de examen de WSD.
CreateScanJobRequest también puede devolver los siguientes errores:
ServerErrorNotAcceptingJobs El servidor no puede aceptar un nuevo trabajo de examen. Este error puede producirse porque el escáner se puso en modo de servicio o porque hay una condición de intervención del usuario y se han agotado todos los búferes de memoria. El cliente puede volver a intentar la solicitud sin modificar más adelante con una expectativa de que el servidor se haya desbloqueado y el escáner esté aceptando trabajos de nuevo.
Propiedad Fault Definición [Código] soap:Receiver [Subcódigo] wscn:ServerErrorNotAcceptingJobs [Motivo] El servicio está bloqueado temporalmente y no puede aceptar nuevas solicitudes de trabajo o documentos. [Detalle] None ClientErrorFormatNotSupported El escáner no admite el valor de formato proporcionado.
Propiedad Fault Definición [Código] soap:Sender [Subcódigo] wscn:ClientErrorFormatNotSupported [Motivo] No se admite el valor del parámetro Document Format. [Detalle] Opcional. El servicio de examen puede devolver una lista de formatos admitidos. Los datos de este elemento deben ser de tipo <wscn:FormatSupportedType>. ClientErrorInvalidScanIdentifier El valor SanIdentifier proporcionado no es válido actualmente en el dispositivo de examen.
Propiedad Fault Definición [Código] soap:Sender [Subcódigo] wscn:ClientErrorInvalidScanIdentifier [Motivo] El valor del parámetro ScanIdentifier no es válido actualmente. [Detalle] None ClientErrorInvalidDestinationToken El valor DestinationToken proporcionado no es válido para el dispositivo de examen.
Propiedad Fault Definición [Código] soap:Sender [Subcódigo] wscn:ClientErrorInvalidDestinationToken [Motivo] El valor del parámetro DestinationToken no es válido actualmente. [Detalle] None ClientErrorNoImagesAvailable El servidor no puede aceptar un nuevo trabajo de examen porque no hay medios para escanear. Por ejemplo, este error se genera cuando se ejecuta un trabajo de examen desde el alimentador automático de documentos conectado al escáner y el alimentador está vacío. El cliente puede volver a intentar la solicitud sin modificar más adelante, con la expectativa de que la condición se corrigió y el escáner ahora tenga medios para examinar.
Propiedad Fault Definición [Código] soap:Sender [Subcódigo] wscn:ClientErrorNoImagesAvailable [Motivo] El servidor no tiene imágenes disponibles para adquirir. [Detalle] None
Ejemplos
En el ejemplo de código siguiente se muestra una solicitud de trabajo de examen cuando se inicia el examen desde el dispositivo de examen.
<?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>
En el ejemplo de código siguiente se muestra una solicitud de trabajo de examen cuando se inicia el examen desde una aplicación en el cliente.
<?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>