Consulta de Situação de Tags
Método responsável por realizar a consulta das Tags junto aos fornecedores, informando se o veículo esta disponível ou não junto ao fornecedor pesquisado.
Request
- ENDPOINT: TagExtratta/ConsultarSituacaoTagPlaca
- VERBO: GET
| Índice | Chave | Descrição | Elem. | Tipo | Ocor. | Tam. | Versão |
|---|---|---|---|---|---|---|---|
| 1 | CNPJAplicacao | CNPJ para autenticação da Empresa | E | Caractere | 1-1 | 14 | 1.0 |
| 2 | CNPJEmpresa | CNPJ para autenticação da Empresa | E | Caractere | 1-1 | 14 | 1.0 |
| 3 | DocumentoUsuarioAudit | Documento do usuário que está realizando a operação | E | Caractere | 1-1 | 14 | 1.0 |
| 4 | NomeUsuarioAudit | Nome do usuário que está realizando a operação | E | Caractere | 1-1 | 60 | 1.0 |
| 5 | Token | Gerado a partir do CNPJ de autenticação para validar permissões de acesso | E | Caractere | 1-1 | 100 | 1.0 |
| 6 | Placa | Placa do veículo | E | Caractere | 1-1 | 7 | 1.0 |
| 7 | Fornecedor | Parceiro fornecedor de pedágio para efetuar compra: 0: Desabilitado (padrão); 1: Moedeiro: Carga no cartão moedeiro Extratta (Descontinuado pela ANTT); 2: Via Fácil (Sem Parar); 3: Move Mais; 4: Veloe; 5: Tag Extratta; 6: ConectCar; 7: Taggy Edenred. |
E | Inteiro | 1-1 | 10 | 1.0 |
Modelo de parametro - Request
GET /TagExtratta/ConsultarSituacaoTagPlaca?fornecedor=2&placa=XXX1234&cnpjAplicacao=87481660000110&cnpjEmpresa=87481660000110&documentoUsuarioAudit=87481660000110&nomeUsuarioAudit=Usuario&token=3dslqis1g-ad63-2b55-b795-9aiz82d52b7d
Response
| Índice | Chave | Descrição | Elem. | Tipo | Ocor. | Tam. | Versão |
|---|---|---|---|---|---|---|---|
| 1 | Sucesso | True: Caso não tenha acontecido nenhuma exceção ou validação no processo mesmo não trazendo dados no retorno; False: Qualquer validação ou exceção não tratada pelo sistema que impediu o processo de ser concluído |
E | Booleano | 1-1 | True/False | 1.0 |
| 2 | Mensagem | Mensagem de retorno | E | Caractere | 0-1 | 100 | 1.0 |
| 3 | Objeto | Objeto pai que contém uma lista de informações sobre a viagem. | G | 0-1 | 1.0 | ||
| 3.1 | Sucesso | True: Caso não tenha acontecido nenhuma exceção ou validação no processo; False: Qualquer validação ou exceção não tratada pelo sistema que impediu o processo de ser concluído |
E | Booleano | 1-1 | True/False | 1.0 |
| 3.2 | MensagemRetorno | Mensagem de retorno | E | Caractere | 0-1 | 100 | 1.0 |
| 3.3 | Fornecedor | Parceiro fornecedor de pedágio para efetuar compra: 0: Desabilitado (padrão); 1: Moedeiro: Carga no cartão moedeiro Extratta (Descontinuado pela ANTT); 2: Via Fácil (Sem Parar); 3: Move Mais; 4: Veloe; 5: Tag Extratta; 6: ConectCar; 7: Taggy Edenred. |
E | Inteiro | 1-1 | 10 | 1.0 |
| 3.4 | TagAtiva | True: O veículo em questão possui uma TAG ativa False: O veículo em questão não possui uma TAG ativa |
E | Booleano | 1-1 | True/False | 1.0 |
| 3.5 | MensagemStatusTag | Informação adicional sobre o motivo do veículo não estar com uma TAG ativa | E | Caractere | 0-1 | 100 | 1.0 |
| 3.6 | CodigoStatusTag | Codigo do status da tag no fornecedor | E | Inteiro | 0-1 | 10 | 1.0 |
Modelo de Json - Response
{
"Sucesso": true,
"Mensagem": null,
"Objeto": {
"Sucesso": true,
"MensagemRetorno": null,
"Fornecedor": 2,
"TagAtiva": true,
"MensagemStatusTag": null,
"CodigoStatusTag": 0
},
"Faults": null
}