Elemento CreateScanJobRequest
A operação CreateScanJobRequest necessária prepara um dispositivo para verificação.
Uso
<wscn:CreateScanJobRequest>
child elements
</wscn:CreateScanJobRequest>
Atributos
Não há atributos.
Valor do texto
Nenhum
Elementos filho
| Element |
|---|
| DestinationToken |
| ScanIdentifier |
| ScanTicket |
Elementos pai
Não há elementos pai.
Comentários
O Serviço de Verificação do WSD deve permitir a operação CreateScanJobRequest.
A operação CreateScanJobRequest é o principal mecanismo para preparar um dispositivo de verificação para verificar as imagens que estão disponíveis para ele. Esta operação pode ser iniciada por dois métodos diferentes. Cada método envia argumentos diferentes para CreateScanJobRequest. Os dois métodos e argumentos são:
O usuário seleciona um destino e pressiona o botão de verificação no dispositivo. Nesse método, o cliente envia um CreateScanJobRequest com os seguintes elementos filhos:
O elemento ScanIdentifier que o Serviço de Verificação retorna ao cliente por meio de ScanAvailableEvent. O Serviço de Verificação deve verificar esse identificador para que o cliente correto esteja solicitando a verificação depois que o usuário tiver selecionado o destino.
O elemento DestinationToken que o Serviço de Verificação WSD retorna ao cliente quando ele se inscreveu para receber eventos ScanAvailableEvent. O Serviço de Verificação deve verificar se o cliente correto está solicitando a verificação por meio desse token.
Um elemento ScanTicket para controlar o processamento da verificação. Os valores no tíquete de verificação são os valores padrão definidos no cliente antes de o usuário acessar o dispositivo para iniciar a verificação.
O usuário inicia um aplicativo no cliente e adquire uma imagem. Nesse método, o cliente envia CreateScanJobRequest apenas com o elemento ScanTicket.
Determinados elementos dentro da hierarquia CreateScanJobRequest podem conter o atributo booliano MustHonor. Se MustHonor estiver presente e for true, o Serviço de Verificação do WSD deverá honrar o elemento solicitado e seu valor ou rejeitar a solicitação de trabalho de verificação. Se um elemento incompatível não tiver um atributo MustHonor ou se seu atributo MustHonor for false, o Serviço de Verificação do WSD deverá ignorá-lo. Se o atributo MustHonor de um elemento compatível for false, o Serviço de Verificação do WSD deverá substituir o valor solicitado por outro compatível.
Se o cliente fornecer uma combinação conflitante de elementos na solicitação de trabalho de verificação (como InputSource e Resolution), o Serviço de Verificação do WSD deverá rejeitar essa solicitação se os elementos conflitantes tiverem um valor de atributo MustHonor de true.
Os seguintes elementos podem ter o atributo MustHonor: ColorProcessing, CompressionQualityFactor, ContentType, Exposure, FilmScanMode, ImagesToTransfer, InputSize, InputSource, MediaSides, Resolution, Rotation, Scaling, ScanRegionHeight, ScanRegionWidth, ScanRegionXOffset e ScanRegionYOffset.
Essa operação pode retornar todos os códigos de erro comuns da operação do Serviço de Verificação do WSD. Para obter mais informações sobre como relatar erros, consulte Relatório de erros da operação do Serviço de Verificação do WSD.
CreateScanJobRequest também pode retornar os seguintes erros:
ServerErrorNotAcceptingJobs O servidor não pode aceitar um novo trabalho de verificação. Esse erro pode ocorrer porque o scanner foi colocado no modo de serviço ou porque há uma condição de intervenção do usuário, e todos os buffers de memória foram esgotados. O cliente pode tentar a solicitação não modificada novamente em outro momento, com a expectativa de que o servidor tenha sido desbloqueado e o verificador esteja aceitando trabalhos novamente.
Propriedade com falha Definição [Code] soap:Receiver [Subcode] wscn:ServerErrorNotAcceptingJobs [Reason] O serviço está temporariamente bloqueado e não pode aceitar novas solicitações de trabalho ou documento. [Detail] Nenhum ClientErrorFormatNotSupported O scanner não aceita o valor de Format fornecido.
Propriedade com falha Definição [Code] soap:Sender [Subcode] wscn:ClientErrorFormatNotSupported [Reason] O valor do parâmetro Document Format não é suportado. [Detail] Opcional. O Serviço de Verificação pode retornar uma lista de formatos compatíveis. Os dados nesse elemento devem ser do tipo <wscn:FormatSupportedType>. ClientErrorInvalidScanIdentifier No momento, o valor ScanIdentifier informado não é válido no dispositivo de verificação.
Propriedade com falha Definição [Code] soap:Sender [Subcode] wscn:ClientErrorInvalidScanIdentifier [Reason] O valor do parâmetro ScanIdentifier não é válido no momento. [Detail] Nenhum ClientErrorInvalidDestinationToken O valor DestinationToken informado não é válido para o dispositivo de verificação.
Propriedade com falha Definição [Code] soap:Sender [Subcode] wscn:ClientErrorInvalidDestinationToken [Reason] O valor do parâmetro DestinationToken não é válido no momento. [Detail] Nenhum ClientErrorNoImagesAvailable O servidor não pode aceitar um novo trabalho de verificação porque não há mídia para verificar. Por exemplo, esse erro é gerado quando um trabalho de verificação é executado a partir do Alimentador Automático de Documentos anexado ao scanner e o alimentador está vazio. O cliente pode tentar a solicitação não modificada novamente mais tarde, com a expectativa de que a condição foi corrigida e o scanner agora tem mídia para ser verificada.
Propriedade com falha Definição [Code] soap:Sender [Subcode] wscn:ClientErrorNoImagesAvailable [Reason] O servidor não tem imagens disponíveis para aquirir. [Detail] Nenhum
Exemplos
O exemplo de código a seguir mostra uma solicitação de trabalho quando a verificação é iniciada a partir do dispositivo de verificação.
<?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>
O exemplo de código a seguir mostra uma solicitação de trabalho de verificação quando a verificação é iniciada a partir de um aplicativo no 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>