Web Service - NFComStatusServico

Conteúdo técnico do capítulo do Web Service NFComStatusServico do MOC NFCom - Padrões Técnicos de Comunicação v.1.00a. O MOC Online é material de apoio e não substitui o documento oficial.

Função: serviço destinado à consulta do status do serviço prestado pelo Ambiente Autorizador;
Processo: síncrono;
Nome do serviço: NFComStatusServico;
Método: nfcomStatusServicoNF;
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: consStatServNFCom_v9.99.xsd.

Tabela 1-1 - Mensagem de Entrada do NFComStatusServico

#	Campo	Ele.	Pai	Tipo	Ocor.	Tam.	Descrição/Observação
EP01	consStatServNFCom	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 do status do serviço.

Schema XML: retConsStatServNFCom_v9.99.xsd.

Tabela 2-1 - Mensagem de Retorno do NFComStatusServico

#	Campo	Ele.	Pai	Tipo	Ocor.	Tam.	Descrição/Observação
ER01	retConsStatServNFCom	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 3-4	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 a data e a 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 recebe as solicitações referentes à consulta do status do serviço do Ambiente Autorizador.

O aplicativo do contribuinte envia a solicitação ao Web Service do Ambiente Autorizador. Ao recebê-la, a aplicação processa a consulta e retorna 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 o 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 Básicas do Serviço

Deverão ser aplicadas as validações gerais conforme o quadro abaixo:

Tabela 4-1 - Grupos de Validação Aplicáveis

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.

5. Validação das Regras de Negócio da Consulta Status Serviço

Tabela 5-1 - Regras de Validação 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.

6. Final do Processamento

O processamento do pedido de consulta do status do serviço pode resultar em uma mensagem de erro ou retornar a situação atual do Servidor de Processamento.

Tabela 6-1 - Situações do Serviço

cStat	Situação
107	Serviço em Operação.
108	Serviço Paralisado Momentaneamente.
109	Serviço Paralisado sem Previsão.

A critério da UF, o campo xObs pode ser utilizado para fornecer maiores informações ao contribuinte, como “manutenção programada”, “modificação de versão do aplicativo” e “previsão de retorno”.