Web Service - NFAgStatusServico
Função: serviço destinado à consulta do status do serviço prestado pelo Ambiente Autorizador.
Processo: síncrono.
Nome Serviço: NFAgStatusServico.
Método: NFAgStatusServicoNF.
Parâmetro da Mensagem da área de dados: XML sem compactação.
1. Leiaute da Mensagem de Entrada
Entrada: Estrutura XML contendo a consulta do status do serviço.
Schema XML: consStatServNFAg_v9.99.xsd.
| # | Campo | Ele | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| EP01 | consStatServNFAg | Raiz | - | - | - | - | TAG raiz |
| EP02 | versao | A | EP01 | N | 1-1 | 2v2 | Versão do leiaute |
| EP03 | tpAmb | E | EP01 | N | 1-1 | 1 | Identificação do Ambiente: 1 – Produção / 2 - Homologação |
| EP04 | xServ | E | EP01 | C | 1-1 | 6 | Serviço solicitado: ‘STATUS’ |
2. Leiaute da Mensagem de Retorno
Retorno: Estrutura XML com o resultado da consulta status serviço.
Schema XML: retConsStatServNFAg_v9.99.xsd.
| # | Campo | Ele | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| ER01 | retConsStatServNFAg | Raiz | - | - | - | - | TAG raiz da Resposta |
| ER02 | versao | A | ER01 | N | 1-1 | 2v2 | Versão do leiaute |
| ER03 | tpAmb | E | ER01 | N | 1-1 | 1 | Identificação do Ambiente: 1 – Produção / 2 - Homologação |
| ER04 | verAplic | E | ER01 | C | 1-1 | 1-20 | Versão do Aplicativo que processou a consulta |
| ER05 | cStat | E | ER01 | N | 1-1 | 3 | Código do status da resposta |
| ER06 | xMotivo | E | ER01 | C | 1-1 | 1-255 | Descrição literal do status da resposta |
| ER07 | cUF | E | ER01 | N | 1-1 | 2 | Código da UF que atendeu à solicitação |
| ER08 | dhRecbto | E | ER01 | D | 1-1 | - | Data e hora de recebimento do pedido Formato = AAAA-MM-DDTHH:MM:SS TZD |
| ER09 | tMed | E | ER01 | N | 0-1 | 1-4 | Tempo médio de resposta do serviço (em segundos) dos últimos 5 minutos |
| ER10 | dhRetorno | E | ER01 | D | 0-1 | - | Preencher com data e hora previstas para o retorno do Web Service, no formato AAA-MM-DDTHH:MM:SS |
| ER11 | xObs | E | ER01 | C | 0-1 | 1-255 | Informações adicionais ao contribuinte |
3. Descrição do Processo de Web Service
Este método será responsável por receber as solicitações referentes à consulta do status do serviço do Ambiente Autorizador.
O aplicativo do contribuinte envia a solicitação para o Web Service do Ambiente Autorizador. Ao receber a solicitação, a aplicação processará a consulta e retornará mensagem contendo o status do serviço.
A empresa que construir aplicativo que se mantenha em permanente “loop” de consulta a este Web Service deverá aguardar um tempo mínimo de 3 minutos entre uma consulta e outra, evitando sobrecarga desnecessária dos servidores do Ambiente Autorizador.
4. Regras de Validação
| Grupo | Descrição |
|---|---|
| A | Validação do Certificado de Transmissão (protocolo TLS) |
| B | Validação Inicial da Mensagem no Web Service |
| C | Validação da Área de Dados da mensagem |
4.1. Validação das Regras de Negócio da Consulta Status Serviço
| # | Regra de Validação | Aplic. | cStat | Efeito | Mensagem |
|---|---|---|---|---|---|
| J01 | Tipo do ambiente informado difere do ambiente do Web Service | Obrig. | 252 | Rej. | Rejeição: Ambiente informado diverge do Ambiente de recebimento |
| J02 | Verifica se o Servidor de Processamento está Paralisado Momentaneamente | Obrig. | 108 | - | Serviço Paralisado Momentaneamente (curto prazo) |
| J03 | Verifica se o Servidor de Processamento está Paralisado sem Previsão | Obrig. | 109 | - | Serviço Paralisado sem Previsão |
5. Final do Processamento
O processamento do pedido de consulta de status de Serviço pode resultar em uma mensagem de erro ou retornar a situação atual do Servidor de Processamento, códigos de situação 107 (“Serviço em Operação”), 108 (“Serviço Paralisado Momentaneamente”) e 109 (“Serviço Paralisado sem Previsão”).