Web Service - BPeStatusServico
cStat nos Schemas de retorno.- Função: consulta do status do serviço prestado pelo Ambiente Autorizador.
- Processo: síncrono.
- Método:
bpeStatusServicoBP. - Parâmetro da mensagem da área de dados: XML sem compactação.
1. Leiaute da Mensagem de Entrada
Entrada: estrutura XML para a consulta do status do serviço.
Schema XML: consStatServBPe_v99.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| CP01 | consStatServBPe | Raiz | - | - | - | - | TAG raiz. |
| CP02 | versao | A | CP01 | N | 1-1 | 2v2 | Versão do leiaute. |
| CP03 | tpAmb | E | CP01 | N | 1-1 | 1 | Identificação do ambiente: 1 - Produção; 2 - Homologação. |
| CP04 | xServ | E | CP01 | 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: retConsStatServBPe_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| CR01 | retConsStatServBPe | Raiz | - | - | - | - | TAG raiz da resposta. |
| CR02 | versao | A | CR01 | N | 1-1 | 2v2 | Versão do leiaute. |
| CR03 | tpAmb | E | CR01 | N | 1-1 | 1 | Identificação do ambiente: 1 - Produção; 2 - Homologação. |
| CR04 | verAplic | E | CR01 | C | 1-1 | 1-20 | Versão do aplicativo que processou a consulta. |
| CR05 | cStat | E | CR01 | N | 1-1 | 3-4 | Código do status da resposta. |
| CR06 | xMotivo | E | CR01 | C | 1-1 | 1-255 | Descrição literal do status da resposta. |
| CR07 | cUF | E | CR01 | N | 1-1 | 2 | Código da UF que atendeu à solicitação. |
| CR08 | dhRecbto | E | CR01 | D | 1-1 | - | Data e hora de recebimento do pedido. Formato: AAAA-MM-DDTHH:MM:SS TZD. |
| CR09 | tMed | E | CR01 | N | 0-1 | 1-4 | Tempo médio de resposta do serviço, em segundos, nos últimos 5 minutos. |
| CR10 | dhRetorno | E | CR01 | D | 0-1 | - | Data e hora previstas para o retorno do Web Service. |
| CR11 | xObs | E | CR01 | C | 0-1 | 1-255 | Informações adicionais ao contribuinte. |
3. Descrição do Processo de Web Service
O aplicativo do contribuinte envia a solicitação para o Web Service do Ambiente Autorizador. A aplicação processa a consulta e retorna mensagem contendo o status do serviço.
Aplicativos mantidos em consulta permanente devem aguardar no mínimo 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
| Grupo | Descrição |
|---|---|
| A | Validação do Certificado de Transmissão no 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
| # | 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 | Verificar se o Servidor de Processamento está paralisado momentaneamente. | Obrig. | 108 | - | Serviço Paralisado Momentaneamente (curto prazo). |
| J03 | Verificar se o Servidor de Processamento está paralisado sem previsão. | Obrig. | 109 | - | Serviço Paralisado sem Previsão. |
6. Final do Processamento
O pedido pode resultar em mensagem de erro ou retornar a situação atual do Servidor de Processamento.
| cStat | Situação |
|---|---|
| 107 | Serviço em Operação. |
| 108 | Serviço Paralisado Momentaneamente. |
| 109 | Serviço Paralisado sem Previsão. |
O campo xObs pode ser utilizado, a critério da UF, para fornecer informações adicionais ao contribuinte.