Web Service — DCeStatusServico

Consulta da disponibilidade do serviço de autorização da DC-e na UF.

Função:

Processo:

Método:

dceStatusServico

Schema entrada:

consStatServ_v1.00.xsd

Schema retorno:

retConsStatServ_1.00.xsd

1.1. Leiaute Da Mensagem De Entrada

Entrada: estrutura XML para a consulta do status do serviço.

Tabela 5-8 — Leiaute da mensagem de entrada do Web Service dceStatusServico (schema `consStatServ_v1.00.xsd`)
#	Campo	Ele	Pai	Tipo	Ocor.	Tam.	Descrição / Observação
FP01	consStatServ	Raiz	–	–	–	–	TAG raiz.
FP02	versao	A	FP01	N	1-1	1-2v2	Versão do leiaute.
FP03	tpAmb	E	FP01	N	1-1	1	Identificação do ambiente: 1 = Produção; 2 = Homologação.
FP04	cUF	E	FP01	N	1-1	2	Código da UF consultada.
FP05	xServ	E	FP01	C	1-1	6	Serviço solicitado: STATUS.

1.2. Leiaute Da Mensagem De Retorno

Retorno: estrutura XML contendo o resultado da consulta do status do serviço.

Tabela 5-9 — Leiaute da mensagem de retorno do Web Service dceStatusServico (schema `retConsStatServ_1.00.xsd`)
#	Campo	Ele	Pai	Tipo	Ocor.	Tam.	Descrição / Observação
FR01	retConsStatServ	Raiz	–	–	–	–	TAG raiz da resposta.
FR02	versao	A	FR01	N	1-1	1-2v2	Versão do leiaute.
FR03	tpAmb	E	FR01	N	1-1	1	Identificação do ambiente: 1 = Produção; 2 = Homologação.
FR04	verAplic	E	FR01	C	1-1	1-20	Versão do aplicativo que processou a consulta.
FR05	cStat	E	FR01	N	1-1	3	Código do status da resposta.
FR06	xMotivo	E	FR01	C	1-1	1-60	Descrição literal do status da resposta.
FR07	cUF	E	FR01	N	1-1	2	Código da UF que atendeu a solicitação.
FR08	dhRecbto	E	FR01	D	1-1	–	Data e hora do processamento. Formato AAAA-MM-DDThh:mm:ssTZD (UTC).
FR09	tMed	E	FR01	N	0-1	1-4	Tempo médio de resposta do serviço, em segundos, nos últimos 5 minutos.
FR10	dhRetorno	E	FR01	D	0-1	–	Data e hora previstas para o retorno do Web Service, no formato AAAA-MM-DDTHH:MM:SS.
FR11	xObs	E	FR01	C	0-1	1-255	Informações adicionais.

1.3. Descrição Do Processo

O método recebe as solicitações de consulta do status do serviço do Portal da Secretaria de Fazenda Estadual. Ao receber a solicitação, a aplicação do Portal a processa e retorna a mensagem contendo o status do serviço.

1.4. Regras De Validação

1.4.1. Regras Genéricas

Tabela 5-10 — Grupos de regras de validação genéricas do Web Service dceStatusServico
Grupo	Descrição
A	Validação do certificado de transmissão (protocolo TLS).
B	Validação inicial da mensagem no Web Service.
D	Validação da área de dados.

Sem validação de assinatura: Este é o único serviço da DC-e que não aplica os grupos E (certificado digital de assinatura) e F (assinatura digital): a mensagem de consulta de status não é assinada.

1.4.2. Regras Específicas

Tabela 5-11 — Regras de validação específicas do Web Service dceStatusServico
#	Regra de validação	Aplic.	Msg	Efeito	Descrição do erro
K01	Tipo do ambiente da DC-e difere do ambiente do Web Service.	Obrig.	252	Rej.	Rejeição: Ambiente informado diverge do Ambiente de recebimento.
K02	Código da UF consultada difere da UF do Web Service.	Obrig.	289	Rej.	Rejeição: Código da UF informada diverge da UF solicitada.
K03	Verifica se o servidor de processamento está paralisado momentaneamente.	Obrig.	108	Rej.	Rejeição: Serviço paralisado momentaneamente (curto prazo).
K04	Verifica se o servidor de processamento está paralisado sem previsão.	Obrig.	109	Rej.	Rejeição: Serviço paralisado sem previsão.

1.5. Final Do Processamento

O processamento do pedido pode resultar em mensagem de erro ou no retorno da situação atual do servidor de processamento:

Códigos de situação do serviço
cStat	Situação
107	Serviço em operação.
108	Serviço paralisado temporariamente.
109	Serviço paralisado sem previsão.

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

Web Service DCeStatusServico