DSERTSS3-2069 - [B.E] - CT-e OS Emitidos: API - Exportação do XML (individual e em lote)

01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

• Criação da funcionalidade de exportação de xml dos documentos de CT-e OS emitidos.

03. SOLUÇÃO

1. Implementação do endpoint (GET) http para solicitação do xml de um CT-e OS em base 64 a partir do parâmetro de id do documento, como exemplificado a seguir: /api/cteos/{id}/exportxml
   
   1. Durante o processamento da requisição pelo endpoint, o recurso produz:
      1. O acesso ao documento e consulta do XML quando disponível.
      2. Conversão do XML gravado em base 64 para o tipo string, fazendo então o envelopamento da string.
      3. Conversão do XML para base 64 novamente com a finalidade de responder ao client solicitante.
2. Implementação do endpoint (POST) http para requisição do lote de xmls de CT-e OS a partir do parâmetro filter (OData Query) possibilitando a solicitação dos documentos que estejam contidos na consulta, conforme exemplificado a seguir:  /api/cteos/exportxmlbatch?$filter=CteOsId in ('541000023120')
   1. Durante o processamento da requisição pelo endpoint, o recurso produz:
      1. A validação da existência de um filter contido no endpoint para que se identificado em falta a requisição seja interrompida com a resposta de número 400 bad request.
      2. Envio da solicitação para o processamento assíncrono que será executado posteriormente pelo mecanismo de filas em background service/worker.
      3. Produção da resposta pela API informando que a mensagem foi encaminhada e informando o recibo (receipt) para possibilitar consulta posterior, bem como o download dos xmls contidos no filter especificado; conforme exemplificado a seguir:
      4. 

04. DEMAIS INFORMAÇÕES

• Não há

05. ASSUNTOS RELACIONADOS

• Não há