6. API da ANTT para emissão do CIOT
6.8. Consulta Exceção
6.7.2. Gerar Origem e destino Encerramento
« Anterior
6.9. Consulta CIOT Gerado
Próximo »

6.8. Consulta Exceção

Consultar Exceção

Importante

Ainda não conseguimos confirmar a disponibilidade deste serviço.

Assinatura

string ANTT_ConsultaExcecao(int tpAmb, string nomeCertificado, string CpfCnpjTransportador, out int cStat, out string msgResultado, out string msgDados, out string Flag, out string Codigo, out string Mensagem)

Descrição:

Consulta se o transportador está contido na lista de exceções à Resolução 5862.

Certificado Digital

Informar o Nome do titular (campo Assunto) do certificado digital a ser utilizado na conexão SSL.

Parâmetros da chamada:

nome tipo fluxo descrição
ambiente inteiro entrada informar o código do ambiente que deseja acessar:
1- produção ou 2-homologação
nomeCertificado string entrada informar nome do titular do certificado a ser utilizado na autenticação com a API:

1. informar o assunto do certificado digital que deve existir no repositório MY do current user, ex.: "CN=NFe - Associacao NF-e:99999090910270, C=BR, L=PORTO ALEGRE, O=Teste Projeto NFe RS, OU=Teste Projeto NFe RS, S=RS".
2. informar: NUMEROSERIE|[número de série] quando não seja possível localizar o certificado digital pelo assunto;
3. informar: ARQUIVO | [nome do arquivo pfx com caminho completo] | [senha do arquivo] para uso do certificado digital em arquivo pfx, ex.: "ARQUIVO|c:\certificado.pfx|senha".
4. informar: CERTIFICADO | [string base64 do arquivo pfx] | [senha do arquivo] no parâmetro NomeCertificado para passar uma string contendo um certificado digital em base64, ex.:"CERTIFICADO|MIIGoDCCBYigAwIBAgIQep(arquivo pfx do certificado digital convertido em base64...)QQDExNBQy|senha".
CpfCnpjTransportador string entrada informar o CPF ou CNPJ do transportador a ser consultado
cStat inteiro saída retorna um código numérico devolvido pela API, exemplos de retorno:
200-[mensagem do WS]
400-Bad Request
401-Unauthorized
500-Internal Server Error,
etc.
msgResultado string saída retorna um texto com a resposta devolvida pela API
msgDados string saída retorna a mensagem Json enviada para a API
Flag string saída retorna um Flag que indica se o transportador está contida na lista de exceção.
false - não contido na lista
true - contido na lista.
Codigo string saída retorna o Código do erro ou sucesso no retorno da informação.
Mensagem string saída retorna a mensagem do resultado da chamada da API

Retorno da chamada:

O resultado da chamada da API ANTT_ConsultaCIOTGerado é a resposta JSON, exemplo:

{
"Retorno": {
           "CpfCnpjTransportador": "11222333456789",
           "Flag" : false,
           "Codigo": [ "111" ],
           "Mensagem": [ "Código 111 - Consulta realizada com sucesso!" ]
          }
}

Histórico de atualização:

Exemplo de JSON da resposta "Consulta realizada com sucesso!"

 
{
"Retorno": {
           "CpfCnpjTransportador": "10142785000190",
           "Flag" : false,
           "Codigo": [ "111" ],
           "Mensagem": [ "Código 111 - Consulta realizada com sucesso!" ]
          }
}

Importante

O trecho do JSON foi formatado para uma melhor visualização, a mensagem original não tem formatação.

Exemplos de uso:

c#

 
// inicialização das variáveis utilizadas
 
int tpAmb = 2;
string nomeCertificado = "CN=FLEXDOCS INFORMATICA LTDA:10142785000190, OU=presencial, OU=20085105000106, OU=RFB e-CNPJ A1, OU=Secretaria da Receita Federal do Brasil - RFB, L=OURINHOS, S=SP, O=ICP-Brasil, C=BR";
 
string CpfCNPJTransportador = "10142785000190";
string Flag = "";
 
int cStat = 0;
string msgResultado = "";
string msgDados = "";
string msgRetWS = "";
string Mensagem = "";
string Protocolo = "";
string Codigo = "";
 
// instancia DLL
 
MDFe_Util.Util util = new MDFe_Util.Util();
 
// consome API
 
msgRetWS = util.ANTT_ConsultaExcecao(tpAmb, 
                                     nomeCertificado,
                                     CpfCNPJTransportador,
                                     out cStat,
                                     out msgResultado,
                                     out msgDados,
                                     out Flag,
                                     out Codigo,
                                     out Mensagem);
 
// exibe resposta da API
 
MessageBox.Show(util.formataJsonmsgResultado),"Consultar Exceção");
 
//
6.8. Consulta Exceção
6. API da ANTT para emissão do CIOT
« Anterior
6.7.2. Gerar Origem e destino Encerramento
Próximo »
6.9. Consulta CIOT Gerado