Documentação do WebService Trafegus

Documentação WebService Trafegus

[v.2.44.4766]

Orientações Gerais sobre o webservices Trafegus:

O sistema Trafegus possui sua camada de integração webservice que funciona tendo como base a arquitetura REST, e seus métodos para envio e recebimento de dados estão disponíveis via: GET, POST e PUT (para buscar, incluir ou alterar dados respectivamente).
Todos os envios e retornos deste webservice serão realizados em formato JSON.
Para a realização de testes de comunicação com este webservice poderão ser utilizadas aplicações como POSTMAN.
Todos os métodos possuem o Basic Authentication, do protocolo HTTP para acesso das informações, Ele é incluído no header da requisição HTTP dessa maneira: Authorization: Basic {credenciais em base 64 no formato usuário:senha}
Para preenchimento do header X-App-Trafegus, deve ser solicitado um código de aplicação à Trafegus

Exemplo:
$request->setHeaders(array(
'content-type' => 'application/json',
'authorization' => 'Basic '. base64_encode("user:password"),
'X-App-Trafegus' => 777
));

Nos métodos apresentados neste manual aonde são utilzados array's "[]", podem ser enviado vários objetos em uma mesma requisição, conforme exemplo abaixo: "veiculos":[ -- podem ser enviados vários veiculos dentro deste array. { "placa":"GBK2100", "nro_liberacao":111, "escolta":"S" }, { "placa":"DPE1444", "nro_liberacao":222, "escolta":"N" } ]

POST para inserção:
http://ip.do.cliente:porta/ws_rest/public/api/viagem
http://ip.do.cliente:porta/ws_rest/public/api/transportador
http://ip.do.cliente:porta/ws_rest/public/api/embarcador
http://ip.do.cliente:porta/ws_rest/public/api/motorista
http://ip.do.cliente:porta/ws_rest/public/api/veiculo
http://ip.do.cliente:porta/ws_rest/public/api/pgr
http://ip.do.cliente:porta/ws_rest/public/api/ajudante

PUT para atualização:
http://ip.do.cliente:porta/ws_rest/public/api/viagem/IdViagem
http://ip.do.cliente:porta/ws_rest/public/api/transportador/IdTransportador
http://ip.do.cliente:porta/ws_rest/public/api/embarcador/IdEmbarcador
http://ip.do.cliente:porta/ws_rest/public/api/motorista/IdMotorista
http://ip.do.cliente:porta/ws_rest/public/api/veiculo/IdVeiculo
http://ip.do.cliente:porta/ws_rest/public/api/ajudante/IdAjudante
http://ip.do.cliente:porta/ws_rest/public/api/pgr/IdPGR

Nota I: Antes de fazer qualquer comunicação, por favor, entrar em contato com a Seguradora ou a Trafegus sistemas para que possa ser fornecido o IP do ambiente, usuário e senha.

Nota II: O serviço do Trafegus Webservice roda em um ambiente CentOS 6 (ou superior) com o servidor HTTP Apache, portanto para ser possível a conexão com o mesmo, é necessário que o serviço HTTP esteja Online e também que o servidor CentOS possua conexão com a internet, também é necessário que no servidor CentOS esteja instalado a ferramenta PHP na versão 5 (ou superior).

Nota III: O layout dos métodos relativos a inserção (POST) e atualização (PUT) serão os mesmos.

Nota IV: Todos os métodos de consulta (GET), caso não informado id, será necessário informar um código para a consulta se basear e buscar os próximos 100 registros.

Nota V: Ao serem enviados vários objetos para cadastro, caso não seja possível cadastrar algum deles, o processo todo não será revertido, mantendo na base os que foram cadastrados com sucesso e retornando erro para aquele que houve falha e parando o processo.
Ex: caso forem enviados 6 transportadores e houve falha no 3º, os 2 primeiros não serão revertidos, retornará mensagem de erro para o 3º e irá parar o processo, não tentando cadastrar o 4º, 5º e 6º.

BuscarTransportador

Retorna informações de transportador(es).

Para consultar um transportador em específico, adicione O CPF/CNPJ na url:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/transportador/123456

Para consultar um pacote de transportadores adicione o último código recebido UltCodigo (cada requisição busca 100 registros com os próximos dados a partir do código informado):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/transportador?UltCodigo=123456

Observação: Quando solicitado apenas um transportador a chave "transportador" do retorno será apenas um objeto, não um array.

Retorno JSON

{
    "transportador": [{
                "codigo": 10,
        "documento_transportador": "42088421000166",
        "nome": "CONTATTO",
        "razao_social": "CONTATTO",
        "ie_rg": null,
        "logradouro": null,
        "cep": null,
        "numero": null,
        "complemento": null,
        "bairro": null,
        "cidade": null,
        "sigla_estado": null,
        "pais": null,
        "documento_matriz": null,
        "velocidade_media": null,
        "tempo_total_parado": 0,
        "tempo_tolerancia_atraso": null,
        "senha": null,
        "roteiriza_automatico_sm": 1,
        "Tempo_check_list_fixo": null,
        "Tempo_check_list_agregado": null,
        "Tempo_check_list_terceiro": null,
        "pgr_padrao": null,
        "estacao_gr_padrao": 1,
        "associa_motorista_sm": 0,
        "associa_veiculo_sm": 0,
        "associar_locais_permitidos_viagem": 0,
        "cerca_eletronica_associacao_locais": 500
    }]
}

BuscarEmbarcador

Retorna informações de embarcador(es)

Para consultar um embarcador em específico, adicione o CNPJ na url:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/embarcador/123456

Para consultar um pacote de embarcadores adicione o último código recebido UltCodigo (cada requisição busca 100 registros com os próximos dados a partir do código informado):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/embarcador?UltCodigo=123456

Observação: Quando solicitado apenas um embarcador a chave "embarcador" do retorno será apenas um objeto, não um array.

Retorno JSON

{
    "embarcador": [
        {
            "codigo": 10,
            "cnpj_embarcador": "47362387000190",
            "nome": "WS A1 EMBA",
            "razao_social": "WS REST",
            "ie": "WS REST",
            "logradouro": "WS REST",
            "cep": "WS REST",
            "numero": "1212",
            "complemento": "WS REST",
            "bairro": "WS REST",
            "DocumentoMatriz":  null,
            "velocidade_media": "55",
            "tempo_total_parado": "120",
            "tempo_tolerancia_atraso": "123",
            "senha": "2222",
            "roteiriza_automatico_sm": 1,
            "pgr_padrao": "23",
            "estacao_gr_padrao": null,
            "associa_motorista_sm": 0,
            "associa_veiculo_sm": 0,
            "associar_locais_permitidos_viagem": 0,
            "cerca_eletronica_associacao_locais": 500
        }
    ]
}

BuscarArea

Retorna informações de áreas

Para consultar uma área em específico, adicione o código na url:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/area/123456

Para consultar um pacote de areas adicione o último código recebido UltCodigo (cada requisição busca 1000 registros com os próximos dados a partir do código informado):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/area?UltCodigo=123456

Observação: Quando solicitado apenas uma area a chave "area" do retorno será apenas um objeto, não um array.

Retorno JSON

{
    "area": [
    {
        "area_codigo": 111,
        "area_descricao": "123",
        "classe_descricao": "Manutenção",
        "data_cadastro": "2016-12-27 09:47:36"
      },
    ]
}

BuscarMotorista

Retorna informações de motorista(s)

Para consultar um motorista em específico, adicione o CPF na url:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/motorista/12345678911

Para consultar um pacote de motoristas cujo CPF inicia com determinados 6 ou mais caracteres:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/motorista?CPF=123456
Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/motorista?CPF=123456789

Para consultar um pacote de motoristas adicione o último código recebido UltCodigo (cada requisição busca 100 registros com os próximos dados a partir do código informado):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/motorista?UltCodigo=123456

Para consultar um pacote de motoristas de um transportador, adicione o parâmetro Documento (cada requisição busca 100 registros):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/motorista?UltCodigo=123456&Documento=12345678901234

Observação: Quando solicitado apenas um motorista a chave "motorista" do retorno será apenas um objeto, não um array.

Retorno JSON

{
    "motorista": [{
        "codigo": 10,
        "cpf_motorista": "69371875569",
        "nome": "WS REST",
        "matricula": "123",
        "empresa_contratante": "001",
        "rg": "20121033950",
        "logradouro": "WS REST",
        "cep": "89817000",
        "numero": "44",
        "complemento": "WS REST",
        "bairro": "WS REST",
        "cidade": "CHAPECO",
        "sigla_estado": "SC",
        "pais": "Brasisl",
        "nro_cnh": "A",
        "categoria_cnh": null,
        "validade_cnh": null,
        "senha": null,
        "vigilante": null,
        "nro_cnv": null,
        "validade_cnv": null,
        "transportador": [
            {
                "documento_transportador": "10884397000185",
                "vinculo_contratual": 2
            }
        ],
        "contatos": [
            {
                "codigo": "1",
                "email": null,
                "fone": "TESTE",
                "fone2": "TESTE",
                "fone3": "TESTE",
                "radio": null
            },
            {
                "codigo": "2",
                "email": null,
                "fone": "01",
                "fone2": "02",
                "fone3": "03",
                "radio": null
            }
        ]
    }]
}

BuscarProfissao

Retorna informações de profissao(s)

Para consultar uma profissao em específico, adicione o Código na url:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/profissao/1

Para consultar todas as profissões:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/profissao

Observação: Quando solicitado apenas uma profissao a chave "profissao" do retorno será apenas um objeto, não um array.

Retorno JSON

                    {
                        "profissao": [
                          {
                            "codigo": 1,
                            "descricao": "MOTORISTA"
                          },
                          {
                            "codigo": 2,
                            "descricao": "AJUDANTE"
                          },
                        ]
                    }

BuscarVeiculo

Retorna informações de veículo(s)

Para consultar um veículo em específico, adicione sua placa na url:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/veiculo/ABC0001

Para consultar um pacote de veículos adicione o último código recebido UltCodigo (cada requisição busca 100 registros com os próximos dados a partir do código informado):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/veiculo?UltCodigo=123456

Para consultar um pacote de veículos de um transportador, adicione o parâmetro Documento (cada requisição busca 100 registros):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/veiculo?UltCodigo=123456&Documento=12345678910123

Observação: Quando solicitado apenas um veículo a chave "veiculo" do retorno será apenas um objeto, não um array.

Retorno JSON

 {
    "veiculo": [{
        "codigo": 9,
        "placa": "ONX0001",
        "frota": "123",
        "renavam": "00093084754",
        "chassi": "SKFAIS90DIF904884",
        "tipo_veiculo": 2,
        "lista_observacoes": [
            {
                "observacao": "OBSERVACO DE EXEMPLO 1"
            },
            {
                "observacao": "OBSERVACO DE EXEMPLO 2"
            }
        ],
        "documento_proprietario": "54735256000176",
        "senha_proprietario": "1234",
        "senha_coacao": "1234",
        "modelo": "CARGO 2218",
        "marca": "FORD 011",
        "ano_fabricacao": "2015",
        "ano_modelo": "2015",
        "cor": "NAO SEI",
        "tamanho": "12.00",
        "cidade_emplacamento": "MIRASSOL",
        "sigla_estado": "AR",
        "pais": "ARGENTINA",
        "telefone": "(9 )3322-1122",
        "antt": "1234567",
        "rntc": "11561",
        "crlv": "123123213213",
        "observacao_veiculo": "TESTE",
        "pgr_minimo_codigo": 123,
        "pgr_minimo_descricao": "PGR 1000000",
        "terminais": [
            {
                "numero": "1988942",
                "tecnologia": "ONIXSAT",
                "codigo_versao_tecnologia": 8
            },{
                "numero": "TRI0003",
                "tecnologia": "ONIXSAT",
                "codigo_versao_tecnologia": 1
            }
        ],
        "transportadores": [
            {
                "documento_transportador": "29872062000175",
                "vinculo_contratual": 1
            }
        ],
        "motoristas": [
            {
                "nome": "TESTE",
                "documento": "123456789-00"
            }
        ]
    }]
}

BuscarAjudante

Retorna informações de ajudante(s)

Para consultar um ajudante em específico, adicione o CPF na url:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/ajudante/123456

Para consultar um pacote de ajudantes adicione o último código recebido UltCodigo (cada requisição busca 100 registros com os próximos dados a partir do código informado):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/ajudante?UltCodigo=123456

Observação: Quando solicitado apenas um ajudante a chave "ajudante" do retorno será apenas um objeto, não um array.

Retorno JSON

{
    "ajudante": [{
        "codigo": 10,
        "cpf_ajudante": "46887166720",
        "nome": "WS REST",
        "rg": "851.668.108-48",
        "logradouro": "WS REST",
        "cep": "89817000",
        "numero": "34",
        "complemento": "WS REST",
        "bairro": "WS REST",
        "cidade": "xaxim",
        "sigla_estado": "SC",
        "pais": "Brasil",
        "contatos": [
            {
                "codigo": "1",
                "email": null,
                "fone": "TESTE",
                "fone2": "TESTE",
                "fone3": "TESTE",
                "radio": null
            },
            {
                "codigo": "2",
                "email": null,
                "fone": "01",
                "fone2": "02",
                "fone3": "03",
                "radio": null
            }
        ]
    }]
}

BuscarPgr

Retorna informações de PGR(s)

Parâmetro	Obrigatório	Descrição
UltCodigo	SIM	Id (código) do último PGR.
Documento	SIM	CNPJ da transportadora do veículo
Ativo	NÃO	S para Ativo e N para inativo

Para consultar um PGR em específico, adicione seu id na url:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/pgr/123456

Para consultar um pacote de PGRs adicione o último código recebido UltCodigo(cada requisição busca 100 registros com os próximos dados a partir do código informado):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/pgr?UltCodigo=123456&Documento=010329231

Para consultar um pacote de PGRs ativos ou inativos adicione o último código recebido UltCodigo(cada requisição busca 100 registros com os próximos dados a partir do código informado) e a flag &Ativo=S ou &Ativo=N:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/pgr?UltCodigo=123456&Ativo=S

Observação: Quando solicitado apenas um PGR a chave "pgr" do retorno será apenas um objeto, não um array. e não filtra Ativo ou Inativo

Retorno JSON

{
    "pgr": [{
        "codigo": 123456,
        "descricao": "PGR COM TODOS OS CONTROLES - TEMPOS EM 2 MINUTOS",
        "data_cadastro": "2013-04-05 15:07:12",
        "grau_risco": 0,
        "valor_minimo": 0,
        "valor_maximo_especifico": 0,
        "valor_total": 0,
        "ativo": "S",
    }]
}

BuscaViagem

Retorna informações de viagem(s)

Para consultar uma viagem em específico, adicione o código da viagem na URL:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem/123456

Para consultar uma viagem em específico sem gerar seu PDF, adicione o parametro "ignorarPdf" na URL:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem/123456?ignorarPdf=1

Para consultar um pacote de viagens adicione o último código recebido UltCodigo(cada requisição busca 100 registros com os próximos dados a partir do código informado):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?UltCodigo=123456

Para consultar um pacote de viagens específico, adicione os códigos de viagem no padrão "Codigo_Viagem,Codigo_Viagem[,...]" (limitado em 100 registros):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?Viagens=123456,123457,123458

Para consultar as viagens realizadas por um Motorista, adicione o número do CPF do motorista no parâmetro MotoristaCPF somente com dígitos:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?MotoristaCPF=12345678900

Para consultar as viagens realizadas por um Veículo, adicione a placa no parâmetro Placa somente com dígitos:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?Placa=AAA0000

Para consultar as viagens realizadas por uma Frota, adicione o identificador da Frota no parâmetro Frota:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?Frota=AAA0000

Para consultar as viagens realizadas por um Transportador, adicione o número do documento (CNPJ ou CPF) do transportador no parâmetro TranspordadorDoc somente com dígitos:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?TranspordadorDoc=12345678900

Para consultar as viagens realizadas por um Embarcador, adicione o número documento (CNPJ) do embarcador no parâmetro EmbarcadorDoc somente com dígitos:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?EmbarcadorDoc=12345678912345

Para consultar as viagens realizadas por um Embarcador e Transportador, adicione o número documento (CNPJ) no parâmetro EmpresasDoc somente com digitos:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?EmpresasDoc=12345678912345,22345678912345,32345678912345

Para consultar as viagens finalizadas em uma data adicionar o valor do dia desejado no parâmetro DataFinalizacao:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?DataFinalizacao=10/09/2018

Para consultar as viagens Iniciadas entre um período de datas, será necessário informar os valores nos parâmetros DataInicioI (data de início da busca) e DataInicioF (data de fim da busca)

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?DataInicioI=09/10/2018&DataInicioF=10/10/2018

Para consultar as viagens Iniciadas em uma Data, será necessário informar os valores nos parâmetros DataEfetivacao

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?DataEfetivacao=09/10/2018

Para consultar as viagens Finalizadas em uma Data, será necessário informar os valores nos parâmetros DataFinalizacaoI (data de início da busca) e DataFinalizacaoF (data de fim da busca)

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?DataFinalizacaoI=09/10/2018&DataFinalizacaoF=10/10/2018

Para consultar as viagens a partir de uma determinada data de alteração, será necessário informar o valor no parâmetro dataAlteracao

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?dataAlteracao=10/09/2018 11:45:00

Para consultar obtendo os tipos de produtos, será necessário informar o paramêtro TipoProdutos com valor true.

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?UltCodigo=1&TipoProdutos=true

Para fazer a ordenação da consulta ser pela data de alteração, enviar a flag OrdenarDataAlteracao. Caso contrário, a ordenação padrão é pelo código da viagem

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?OrdenarDataAlteracao=true

Observação: Quando solicitado apenas uma viagem, a chave "viagem" do retorno será apenas um objeto, não um array.

Para retornar apenas a última viagem, ordenado pelo seu código, de maneira decrescente.

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagem?UltCodigo=1&UltimaViagem=true

O link da tag de retorno "link_mapa_veiculo_viagem" só poderá ser acessado se a viagem tiver um dos status permitidos configurados nas configurações do sistema, através da configuração "Status das Viagens permitidos no Link da Rota".

Retorno JSON

{
    "viagens": [
        {
            "pess_nome_transportador": "EMPRESA TESTE",
            "nome_transportador": "EMPRESA TESTE SA",
            "nome_embarcador": "EMPRESA TESTE SA",
            "descricao_pgr": "OPERACAO TESTE",
            "matriz_emba_nome": "EMBARCADOR MATRIZ TESTE",
            "emba_nome": "EMPRESA TESTE",
            "viag_usuario_adicionou": "WS_TESTE",
            "pess_oras_codigo_transportador": 99999,
            "documento_seguradora": null,
            "quantidade_posicao_manual": 0,
            "data_primeira_posicao_viagem": null,
            "embarcador_telefone": null,
            "cnpj_gr": null,
            "viag_codigo_externo": "9999999",
            "operacao": "",
            "codigoSM": 9999999,
            "viagemId": 9999999,
            "rota_codigo": 9999999,
            "rota_descricao": "",
            "documento_transportador": "00000000000001",
            "status_viagem": "FINALIZADA",
            "cnpj_emba": "999999999999",
            "cnpj_emba_matriz": "099999999999",
            "viag_data_cadastro": "2024-01-01 00:27:13",
            "veiculos": [
                {
                    "placa": "TEST000",
                    "nro_liberacao": null,
                    "escolta": "N",
                    "tipo_veiculo": 2,
                    "tipo_veiculo_descricao": "CAVALO",
                    "tipo_carroceria": null,
                    "tipo_carroceria_descricao": null,
                    "marca": "MARCA TESTE",
                    "modelo": "TESTE",
                    "cor": "BRANCA",
                    "ano_modelo": "2024",
                    "ano_fabricacao": "2024",
                    "eras_descricao": "TESTE - TESTE",
                    "eras_codigo": 1,
                    "frota": "TESTE FROTA",
                    "uf_emplacamento": null,
                    "observacao": null
                },
                {
                    "placa": "TEST001",
                    "nro_liberacao": null,
                    "escolta": "N",
                    "tipo_veiculo": 1,
                    "tipo_veiculo_descricao": "CARRETA",
                    "tipo_carroceria": null,
                    "tipo_carroceria_descricao": null,
                    "marca": "TT",
                    "modelo": "TT/BRASIL TESTE",
                    "cor": "PRETA",
                    "ano_modelo": "2024",
                    "ano_fabricacao": "2024",
                    "eras_descricao": null,
                    "eras_codigo": null,
                    "frota": null,
                    "uf_emplacamento": null,
                    "observacao": null
                }
            ],
            "motoristas": [
                {
                    "nome_moto": "MOTORISTA TESTE",
                    "cpf_moto": "999999999-99",
                    "nro_liberacao": null,
                    "data_validade": null,
                    "data_cadastro_consulta": null,
                    "contatos": null,
                    "vinculo_contratual": "FIXO"
                }
            ],
            "ajudantes": [],
            "terminais": [
                {
                    "term_codigo": 11111,
                    "term_ativo": "S",
                    "vtec_descricao": "TESTE",
                    "tecn_descricao": "TESTE",
                    "data_cadastro": "2024-01-01 17:07:18",
                    "telemonitorado": "N",
                    "pess_oras_codigo_proprietario": 1,
                    "pess_nome_proprietario": "TESTE SA",
                    "term_numero_terminal": "TEST5KK5-3",
                    "term_vtec_codigo": 1,
                    "isca": "N"
                }
            ],
            "viag_data_alteracao": "2024-01-01 03:35:57",
            "viag_ttra_codigo": 1,
            "tipo_viagem": "TRANSFERENCIA",
            "tope_descricao": "",
            "tipo_operacao": [],
            "viag_pgpg_codigo": 111,
            "viag_carregado": "S",
            "viag_numero_manifesto": "88888888",
            "viag_valor_merc_especifica": null,
            "viag_valor_merc_nao_especifica": null,
            "viag_valor_carga": "55555.55",
            "viag_valor_ddr": null,
            "viag_peso_total": null,
            "viag_total_eixos": null,
            "viag_distancia": "",
            "viag_data_inicio": "2024-01-01 03:34:55",
            "viag_data_fim": "2024-01-01 03:35:57",
            "viag_previsao_inicio": "2024-01-01 00:00:00",
            "viag_previsao_fim": "2024-01-01 00:00:00",
            "viag_codigo_pai": null,
            "temperatura": [
                {
                    "Descrição": "FAIXA DE TEMPERATURA 1",
                    "Valor Inicial": 0,
                    "Valor Final": 5,
                    "Data Inicio": "2024-07-31 10:49:28",
                    "Data Fim": null,
                    "sensor_01": "S",
                    "sensor_02": "N",
                    "sensor_03": "N",
                    "sensor_04": "N",
                    "sensor_05": "N",
                    "sensor_06": "N",
                    "sensor_07": "N",
                    "sensor_08": "N",
                    "sensor_09": "N",
                    "sensor_10": "N"
                },
                {
                    "Descrição": "FAIXA DE TEMPERATURA 2",
                    "Valor Inicial": -21,
                    "Valor Final": -10,
                    "Data Inicio": "2024-07-31 10:49:28",
                    "Data Fim": null,
                    "sensor_01": "S",
                    "sensor_02": "N",
                    "sensor_03": "N",
                    "sensor_04": "N",
                    "sensor_05": "N",
                    "sensor_06": "N",
                    "sensor_07": "N",
                    "sensor_08": "N",
                    "sensor_09": "N",
                    "sensor_10": "N"
                }
            ],
            "viag_descricao_carga": null,
            "viag_observacao": null,
            "distancia_restante": 0,
            "percentual_viagem": 100,
            "previsao_fim_recalculada": null,
            "viag_justificativa_liberacao": null,
            "valor_frete": [
                {
                    "viag_codigo": 1,
                    "viag_numero_manifesto": "11111111",
                    "viag_data_cadastro": "2024-01-01 00:27:13",
                    "viag_data_fim": "2024-01-01 03:35:57",
                    "viag_data_inicio": "2024-01-01 03:34:55",
                    "transportador": "TESTE SA",
                    "embarcador": "TESTE SA",
                    "descorigem": "TESTE SA MATRIZ",
                    "descdestino": "TESTE SA FILIAL",
                    "descproprietario": "TESTE SA",
                    "veic_placa": "TEST000",
                    "viag_previsao_inicio": "2024-01-02 00:00:00",
                    "viag_previsao_fim": "2024-01-02 00:00:00",
                    "valor_frete_fechado": null,
                    "valor_frete_km": null,
                    "quantidade_ponto_fiscais": null,
                    "valor_pedagio": "0",
                    "quantidade_motoristas": 0,
                    "valor_motora_adicional": null,
                    "valor_ajudante": null,
                    "vakir_posto_fiscal_hora_adicional": "0",
                    "valor_hora_adicional": null,
                    "valor_km_adicional": "0",
                    "valor_frete": null,
                    "valor_frete_ajustado": null,
                    "justificativa": null,
                    "tempo_previsto": " 02:00:00",
                    "tempo_real": " 00:00:01",
                    "rota_distancia": null,
                    "rota_codigo": 5206291,
                    "rota_descricao": "",
                    "rota_identificador": null,
                    "viag_distancia_realizada": "0.00000000000000000000",
                    "tipo_veiculo": "CAVALO",
                    "viag_redundante": null
                }
            ],
            "viag_redundante": null,
            "campos_adicionais_viagem": [
                {
                    "label_campo_add_01": "TIPO DE VEICULO"
                },
                {
                    "campo_adicional_01": "Cacamba 4 eixos TESTE"
                },
                {
                    "label_campo_add_02": "INSTRUCAO MATRIZ"
                },
                {
                    "campo_adicional_02": "999999999"
                },
                {
                    "label_campo_add_03": "MERCADO"
                },
                {
                    "campo_adicional_03": "1-Interno"
                },
                {
                    "label_campo_add_04": "TRANSPORTADORA"
                },
                {
                    "campo_adicional_04": "999999-TESTE SA"
                },
                {
                    "label_campo_add_05": "DIVISAO COMERCIAL"
                },
                {
                    "campo_adicional_05": "TRANSFERENCIA ENTRE COLIGADAS"
                },
                {
                    "label_campo_add_06": "SIGLA UNIDADE"
                },
                {
                    "campo_adicional_06": "TESTE"
                }
            ],
            "origem": {
                "vloc_codigo": 1111111,
                "vloc_descricao": "TESTE ",
                "vloc_refe_codigo": 111111111111,
                "vloc_raio": "500.00000",
                "logradouro": null,
                "cep": null,
                "numero": null,
                "complemento": null,
                "bairro": null,
                "cida_descricao_ibge": "CAPITAL TESTE - SC",
                "sigla_estado": "SC",
                "pais": "BRASIL",
                "refe_latitude": "-16.6355555000",
                "refe_longitude": "-54.4355555000",
                "refe_raio": "200.00000",
                "refe_km": null,
                "refe_bandeira": null,
                "previsao_chegada": "2024-01-01 03:34:55",
                "previsao_inicio_espera": null,
                "previsao_fim_espera": null,
                "previsao_inicio_carregamento": null,
                "previsao_fim_carregamento": null,
                "previsao_inicio_descarregamento": null,
                "previsao_fim_descarregamento": null,
                "previsao_saida": null,
                "chegada_local": "2024-01-01 00:33:55",
                "saida_local": null,
                "local_baixa": "0.073 TESTE, CAPITAL",
                "latitude_baixa": "-16.6157760000",
                "longitude_baixa": "-54.4597632000",
                "notas_fiscais": [],
                "vloc_documento": "",
                "vloc_refe_documento": null,
                "conhecimentos": [
                    {
                        "vlco_codigo": 1111111,
                        "vlco_numero": "0",
                        "vlco_valor": "99999.00",
                        "vlco_cpf_cnpj": null,
                        "contatos": [],
                        "campos_adicionais_conhecimento": [
                            {
                                "label_campo_add_doc_01": "DATA DA INSTRUÇÃO"
                            },
                            {
                                "campo_adicional_doc_01": "01/01/2024"
                            },
                            {
                                "label_campo_add_doc_02": "DATA DE ENTRADA DO VEÍCULO"
                            },
                            {
                                "campo_adicional_doc_02": "02/01/2024 07:38"
                            },
                            {
                                "label_campo_add_doc_03": "DATA DE INÍCIO DE EMBARQUE"
                            },
                            {
                                "label_campo_add_doc_04": "DATA DO FINAL DO EMBARQUE"
                            },
                            {
                                "label_campo_add_doc_01": "DATA DA INSTRUÇÃO"
                            },
                            {
                                "campo_adicional_doc_01": "01/01/2024"
                            },
                            {
                                "label_campo_add_doc_02": "DATA DE ENTRADA DO VEÍCULO"
                            },
                            {
                                "campo_adicional_doc_02": "01/01/2024 07:38"
                            },
                            {
                                "label_campo_add_doc_03": "DATA DE INÍCIO DE EMBARQUE"
                            },
                            {
                                "label_campo_add_doc_04": "DATA DO FINAL DO EMBARQUE"
                            },
                            {
                                "label_campo_add_doc_01": "DATA DA INSTRUÇÃO"
                            },
                            {
                                "campo_adicional_doc_01": "01/01/2024"
                            },
                            {
                                "label_campo_add_doc_02": "DATA DE ENTRADA DO VEÍCULO"
                            },
                            {
                                "campo_adicional_doc_02": "01/01/2024 00:00"
                            },
                            {
                                "label_campo_add_doc_03": "DATA DE INÍCIO DE EMBARQUE"
                            },
                            {
                                "label_campo_add_doc_04": "DATA DO FINAL DO EMBARQUE"
                            },
                            {
                                "label_campo_add_doc_01": "DATA DA INSTRUÇÃO"
                            },
                            {
                                "campo_adicional_doc_01": "01/01/2024"
                            },
                            {
                                "label_campo_add_doc_02": "DATA DE ENTRADA DO VEÍCULO"
                            },
                            {
                                "campo_adicional_doc_02": "01/01/2024 07:38"
                            },
                            {
                                "label_campo_add_doc_03": "DATA DE INÍCIO DE EMBARQUE"
                            },
                            {
                                "campo_adicional_doc_03": "01/01/2024 23:21"
                            },
                            {
                                "label_campo_add_doc_04": "DATA DO FINAL DO EMBARQUE"
                            },
                            {
                                "campo_adicional_doc_04": "01/01/2024 23:22"
                            }
                        ],
                        "pess_nome": null,
                        "pess_oras_codigo": null,
                        "ativo": "N",
                        "notas_fiscais": []
                    }
                ],
                "avaliacoes": {
                    "notas": [
                        {
                            "apre_codigo": null,
                            "apre_nota": null,
                            "apar_codigo": 1,
                            "apar_descricao": "Recepção"
                        },
                        {
                            "apre_codigo": null,
                            "apre_nota": null,
                            "apar_codigo": 2,
                            "apar_descricao": "Agilidade"
                        },
                        {
                            "apre_codigo": null,
                            "apre_nota": null,
                            "apar_codigo": 3,
                            "apar_descricao": "Tempo"
                        },
                        {
                            "apre_codigo": null,
                            "apre_nota": null,
                            "apar_codigo": 4,
                            "apar_descricao": "Localização"
                        }
                    ]
                },
                "local_permitido": "N"
            },
            "destino": {
                "vloc_codigo": 111111111111,
                "vloc_descricao": "TESTE",
                "vloc_refe_codigo": 11111111111,
                "vloc_raio": "500.00000",
                "logradouro": null,
                "cep": null,
                "numero": null,
                "complemento": null,
                "bairro": null,
                "cidade": null,
                "sigla_estado": null,
                "pais": null,
                "refe_latitude": "-15.4234324234",
                "refe_longitude": "-52.2460000000",
                "refe_raio": null,
                "refe_km": null,
                "refe_bandeira": null,
                "previsao_chegada": "2024-01-01 08:05:55",
                "previsao_inicio_espera": null,
                "previsao_fim_espera": null,
                "previsao_inicio_carregamento": null,
                "previsao_fim_carregamento": null,
                "previsao_inicio_descarregamento": null,
                "previsao_fim_descarregamento": null,
                "previsao_saida": null,
                "chegada_local": null,
                "saida_local": null,
                "local_baixa": null,
                "latitude_baixa": null,
                "longitude_baixa": null,
                "link_mapa_veiculo_viagem": "http://trafegus.com.br/trafegusweb/mapaviagem/linkgeradotestetesteteste",
                "link_pdf_viagem": "http://trafegus.com.br/ws_rest/public/doc/pdfs/linkgeradotestetesteteste.pdf",
                "notas_fiscais": [
                    {
                        "campos_adicionais_nf": [
                        ],
                        "destinatario": {
                            "cep": "99999-001",
                            "cida_descricao_ibge": "CIDADE TESTE - SP",
                            "refe_codigo": 11111111,
                            "refe_descricao": "TESTE TESTE TESTE",
                            "refe_latitude": "-22.7198920000",
                            "refe_longitude": "-46.7240790000"
                        },
                        "fotos": [
                        ],
                        "nfst_status": null,
                        "ocorrencia_anomalia": {
                            "oano_cano_codigo": null,
                            "oano_codigo": null,
                            "oano_descricao": null,
                            "oano_descricao_posicao": null,
                            "oano_foto_codigo": null,
                            "oano_latitude": null,
                            "oano_longitude": null,
                            "oano_usua_pfis_pess_oras_codigo": null
                        },
                        "produtos": [
                        ],
                        "remetente": {
                            "cep": "     -   ",
                            "cida_descricao_ibge": "TESTE",
                            "refe_codigo": 99999999,
                            "refe_descricao": "TESTE",
                            "refe_latitude": "-99.9999060000",
                            "refe_longitude": "-46.8238640000"
                        },
                        "vnfi_codigo": 9999999,
                        "vnfi_data_baixa": null,
                        "vnfi_data_devolucao": null,
                        "vnfi_data_fat": "01/01/2024 04:15:06",
                        "vnfi_destinatario": null,
                        "vnfi_nome_recebedor": null,
                        "vnfi_numero": "1111111111",
                        "vnfi_observacao": null,
                        "vnfi_pedido": "5555555",
                        "vnfi_peso": null,
                        "vnfi_remetente": null,
                        "vnfi_status_realizado": null,
                        "vnfi_valor": null,
                        "vnfi_vlco_codigo": 1111111,
                        "vnfi_volumes": null
                    }
                ],
                "vloc_documento": "",
                "vloc_refe_documento": null,
                "conhecimentos": [
                    {
                        "ativo": "S",
                        "campos_adicionais_conhecimento": [
                        ],
                        "contatos": [
                            {
                                "cona_email": null,
                                "cona_observacao": null,
                                "cona_telefone_1": null
                            },
                            {
                                "cona_email": "usuario.teste@EMAILTESTE.COM.BR",
                                "cona_observacao": null,
                                "cona_telefone_1": null
                            }
                        ],
                        "notas_fiscais": [
                            {
                                "campos_adicionais_nf": [
                                ],
                                "destinatario": {
                                    "cep": "99999-001",
                                    "cida_descricao_ibge": "TESTE CIDADE - SC",
                                    "refe_codigo": 102233827,
                                    "refe_descricao": "TESTE ",
                                    "refe_latitude": "-22.7198920000",
                                    "refe_longitude": "-46.7240790000"
                                },
                                "fotos": [
                                ],
                                "nfst_status": null,
                                "ocorrencia_anomalia": {
                                    "oano_cano_codigo": null,
                                    "oano_codigo": null,
                                    "oano_descricao": null,
                                    "oano_descricao_posicao": null,
                                    "oano_foto_codigo": null,
                                    "oano_latitude": null,
                                    "oano_longitude": null,
                                    "oano_usua_pfis_pess_oras_codigo": null
                                },
                                "produtos": [
                                ],
                                "remetente": {
                                    "cep": "     -   ",
                                    "cida_descricao_ibge": "TESTE DEST",
                                    "refe_codigo": 11111111,
                                    "refe_descricao": "TESTE DESTINATARIO",
                                    "refe_latitude": "-22.7111060000",
                                    "refe_longitude": "-46.8238640000"
                                },
                                "vnfi_codigo": 14698377,
                                "vnfi_data_baixa": null,
                                "vnfi_data_devolucao": null,
                                "vnfi_data_fat": "01/01/2024 04:15:06",
                                "vnfi_destinatario": null,
                                "vnfi_nome_recebedor": null,
                                "vnfi_numero": "44444444",
                                "vnfi_observacao": null,
                                "vnfi_pedido": "1111111",
                                "vnfi_peso": null,
                                "vnfi_remetente": null,
                                "vnfi_status_realizado": null,
                                "vnfi_valor": null,
                                "vnfi_vlco_codigo": 11111111,
                                "vnfi_volumes": null
                            }
                        ],
                        "pess_nome": "TESTE - CIDADE TESTE/SP",
                        "pess_oras_codigo": 11111,
                        "vlco_codigo": 11111111,
                        "vlco_cpf_cnpj": "1111111111111111",
                        "vlco_numero": "999999",
                        "vlco_valor": "999.00"
                    }
                ],
                "avaliacoes": {
                    "notas": [
                        {
                            "apre_codigo": null,
                            "apre_nota": null,
                            "apar_codigo": 1,
                            "apar_descricao": "Recepção"
                        },
                        {
                            "apre_codigo": null,
                            "apre_nota": null,
                            "apar_codigo": 2,
                            "apar_descricao": "Agilidade"
                        },
                        {
                            "apre_codigo": null,
                            "apre_nota": null,
                            "apar_codigo": 3,
                            "apar_descricao": "Tempo"
                        },
                        {
                            "apre_codigo": null,
                            "apre_nota": null,
                            "apar_codigo": 4,
                            "apar_descricao": "Localização"
                        }
                    ]
                },
                "local_permitido": "N"
            },
            "locais": [
                {
                    "sequencia_parada": 2,
                    "tipo_parada": "ENTREGA",
                    "tpar_codigo": 3,
                    "vloc_codigo": 9999999999,
                    "vloc_descricao": "TESTE",
                    "vloc_status_realizado": null,
                    "vloc_refe_codigo": 11111111,
                    "vloc_raio": "500.00000",
                    "logradouro": null,
                    "cep": null,
                    "numero": null,
                    "complemento": null,
                    "bairro": null,
                    "cida_descricao_ibge": null,
                    "sigla_estado": null,
                    "pais": null,
                    "refe_latitude": "-15.85555900000",
                    "refe_longitude": "-52.2460000000",
                    "refe_raio": null,
                    "refe_km": null,
                    "refe_bandeira": null,
                    "previsao_chegada": "2024-01-01 00:00:00",
                    "previsao_inicio_espera": null,
                    "previsao_fim_espera": null,
                    "previsao_inicio_carregamento": null,
                    "previsao_fim_carregamento": null,
                    "previsao_inicio_descarregamento": null,
                    "previsao_fim_descarregamento": null,
                    "previsao_saida": "2024-01-01 00:00:00",
                    "chegada_local": null,
                    "saida_local": null,
                    "local_baixa": null,
                    "latitude_baixa": null,
                    "longitude_baixa": null,
                    "notas_fiscais": [
                        {
                            "vnfi_codigo": 111111111,
                            "vnfi_numero": "222222",
                            "vnfi_pedido": "33333333333",
                            "vnfi_valor": "99999.99",
                            "vnfi_data_fat": "2024-01-01 12:48:06",
                            "vnfi_observacao": null,
                            "vnfi_vlco_codigo": 11111111,
                            "vnfi_volumes": null,
                            "vnfi_peso": null,
                            "vnfi_destinatario": null,
                            "vnfi_remetente": null,
                            "vnfi_nome_recebedor": null,
                            "vnfi_status_realizado": null,
                            "vnfi_data_baixa": null,
                            "vnfi_data_devolucao": null,
                            "nfst_status": null,
                            "produtos": [],
                            "remetente": {
                                "refe_codigo": 11111111111,
                                "refe_descricao": "TESTE - TESTE",
                                "refe_latitude": "-22.2214800000",
                                "refe_longitude": "-54.0006300000",
                                "cida_descricao_ibge": "TESTE CIDADE",
                                "cep": "     -   "
                            },
                            "destinatario": {
                                "refe_codigo": 111111111111,
                                "refe_descricao": "CLIENTE TESTE",
                                "refe_latitude": "-22.0847700000",
                                "refe_longitude": "-54.8368400000",
                                "cida_descricao_ibge": "TESTE SAO JOSE DO INHACORA - RS",
                                "cep": "99999-000"
                            },
                            "fotos": [],
                            "campos_adicionais_nf": [
                                {
                                    "label_campo_add_nf_01": "NOME DO REPRESENTANTE"
                                },
                                {
                                    "campo_adicional_nf_01": "432432- PESSOA TESTE"
                                },
                                {
                                    "label_campo_add_nf_02": "DATA APROVAÇÃO NFE"
                                },
                                {
                                    "campo_adicional_nf_02": "01/01/2024 23:25"
                                },
                                {
                                    "label_campo_add_nf_03": "CODIGO/NOME TERCEIRO"
                                },
                                {
                                    "campo_adicional_nf_03": "9999- TESTE"
                                },
                                {
                                    "label_campo_add_nf_04": "DATA ACORDADA"
                                },
                                {
                                    "campo_adicional_nf_04": "01/01/2024 00:00"
                                }
                            ],
                            "ocorrencia_anomalia": {
                                "oano_codigo": null,
                                "oano_descricao": null,
                                "oano_cano_codigo": null,
                                "oano_foto_codigo": null,
                                "oano_latitude": null,
                                "oano_longitude": null,
                                "oano_descricao_posicao": null,
                                "oano_usua_pfis_pess_oras_codigo": null
                            }
                        }
                    ],
                    "vloc_documento": "",
                    "vloc_refe_documento": null,
                    "conhecimentos": [
                        {
                            "vlco_codigo": 3333333,
                            "vlco_numero": "55555555-5",
                            "vlco_valor": "99999.99",
                            "vlco_cpf_cnpj": null,
                            "contatos": [],
                            "campos_adicionais_conhecimento": [],
                            "pess_nome": null,
                            "pess_oras_codigo": null,
                            "ativo": "N",
                            "notas_fiscais": [
                                {
                                    "vnfi_codigo": 111111111,
                                    "vnfi_numero": "2222222",
                                    "vnfi_pedido": "333333333333",
                                    "vnfi_valor": "99999.27",
                                    "vnfi_data_fat": "01/01/2024 12:48:06",
                                    "vnfi_observacao": null,
                                    "vnfi_vlco_codigo": 111111,
                                    "vnfi_volumes": null,
                                    "vnfi_peso": null,
                                    "vnfi_destinatario": null,
                                    "vnfi_remetente": null,
                                    "vnfi_nome_recebedor": null,
                                    "vnfi_status_realizado": null,
                                    "vnfi_data_baixa": null,
                                    "vnfi_data_devolucao": null,
                                    "nfst_status": null,
                                    "produtos": [],
                                    "remetente": {
                                        "refe_codigo": 88888888888,
                                        "refe_descricao": "TESTE",
                                        "refe_latitude": "-22.2214800000",
                                        "refe_longitude": "-54.7226300000",
                                        "cida_descricao_ibge": "TESTE SAO JOSE DO INHACORA - RS",
                                        "cep": "     -   "
                                    },
                                    "destinatario": {
                                        "refe_codigo": 101308284,
                                        "refe_descricao": "PESSOA TESTE",
                                        "refe_latitude": "-22.0847700000",
                                        "refe_longitude": "-54.8368400000",
                                        "cida_descricao_ibge": "TESTE ITU - AM",
                                        "cep": "99999-000"
                                    },
                                    "fotos": [],
                                    "campos_adicionais_nf": [
                                        {
                                            "label_campo_add_nf_01": "NOME DO REPRESENTANTE"
                                        },
                                        {
                                            "campo_adicional_nf_01": "2222-USUARIO TESTE"
                                        },
                                        {
                                            "label_campo_add_nf_02": "DATA APROVAÇÃO NFE"
                                        },
                                        {
                                            "campo_adicional_nf_02": "01/01/2024 23:25"
                                        },
                                        {
                                            "label_campo_add_nf_03": "CODIGO/NOME TERCEIRO"
                                        },
                                        {
                                            "campo_adicional_nf_03": "TESTE"
                                        },
                                        {
                                            "label_campo_add_nf_04": "DATA ACORDADA"
                                        },
                                        {
                                            "campo_adicional_nf_04": "01/01/2024 00:00"
                                        }
                                    ],
                                    "ocorrencia_anomalia": {
                                        "oano_codigo": null,
                                        "oano_descricao": null,
                                        "oano_cano_codigo": null,
                                        "oano_foto_codigo": null,
                                        "oano_latitude": null,
                                        "oano_longitude": null,
                                        "oano_descricao_posicao": null,
                                        "oano_usua_pfis_pess_oras_codigo": null
                                    }
                                }
                            ]
                        }
                    ],
                    "avaliacoes": {
                        "notas": [
                            {
                                "apre_codigo": null,
                                "apre_nota": null,
                                "apar_codigo": 1,
                                "apar_descricao": "Recepção"
                            },
                            {
                                "apre_codigo": null,
                                "apre_nota": null,
                                "apar_codigo": 2,
                                "apar_descricao": "Agilidade"
                            },
                            {
                                "apre_codigo": null,
                                "apre_nota": null,
                                "apar_codigo": 3,
                                "apar_descricao": "Tempo"
                            },
                            {
                                "apre_codigo": null,
                                "apre_nota": null,
                                "apar_codigo": 4,
                                "apar_descricao": "Localização"
                            }
                        ]
                    },
                    "local_permitido": "N"
                }
            ],
            "roteirizar": "N",
            "descricaoRota": "CIDADE 01 CIDADE 02",
            "link_mapa_veiculo_viagem": "https://empresa.com/trafegusweb/mapaviagem/codigogeradolinkaleatorio",
            "regioes_urbanas": [],
            "status_aceite": "N",
            "CTRC": null,
            "cliente": null,
            "historico_status": [
                {
                    "status_viagem": "VIAGEM AGENDADA",
                    "motivo": null,
                    "data_alteracao": "01/01/2024 00:27:13",
                    "usuario": "WS_USUARIO_TESTE"
                },
                {
                    "status_viagem": "VIAGEM EM VIAGEM",
                    "motivo": null,
                    "data_alteracao": "01/01/2024 03:34:55",
                    "usuario": "USER_TESTE"
                },
                {
                    "status_viagem": "VIAGEM FINALIZADA",
                    "motivo": null,
                    "data_alteracao": "01/01/2024 03:35:57",
                    "usuario": "USER_TESTE"
                }
            ]
        }
    ]
}

BuscaNotasFiscais

Retorna as notas fiscais de uma viagem

Parâmetro	Obrigatório	Descrição
Viagem	SIM	Id (código) do último PGR.
Documento	SIM	CNPJ / CPF da empresa associada a viagem.

Para consultar uma nota fiscal em específico, adicione o código da nota na URL:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemnotafiscal/123

Observação: Quando solicitado apenas uma nota fiscal a chave "notasFiscais" do retorno será apenas um objeto, não um array.

Retorno JSON

{
    "notasFiscais": [
        {
            "codigo_nota": 1017,
            "numero_nota": "nf1",
            "valor_nota": "18895017.00",
            "pedido_nota": "321",
            "data_cadastro": "23/05/2019 18:57:58",
            "data_faturamento": "17/05/2019 18:55:11",
            "data_baixa": null,
            "data_devolucao": null,
            "numero_conhecimento": "numerocone1",
            "valor_conhecimento": "18895891.00",
            "local_conhecimento": "DESTINO TESTE",
            "tipo_local_conhecimento": "DESTINO"
        },
        {
            "codigo_nota": 1016,
            "numero_nota": "nf2",
            "valor_nota": "874.00",
            "pedido_nota": "455",
            "data_cadastro": "23/05/2019 18:57:58",
            "data_faturamento": "17/05/2019 18:55:11",
            "data_baixa": null,
            "data_devolucao": null,
            "numero_conhecimento": "numerocone1",
            "valor_conhecimento": "18895891.00",
            "local_conhecimento": "DESTINO TESTE",
            "tipo_local_conhecimento": "DESTINO"
        }
    ]
}

Enviar Viagem

[POST] http://ip.do.cliente:porta/ws_rest/public/api/viagem

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Nível	Tipo	Obrigatório	Descrição
viag_codigo_externo	0	integer	Não	Código da viagem do cliente
viag_ttra_codigo	0	integer	Sim	Tipo de Transporte (verificar constantes na documentação)
viag_pgpg_codigo	0	integer	Sim	PGR para controle da viagem
viag_carregado	0	string(1)	Não	Veículo carregado (S/N)
documento_transportador	0	string(30)	Sim	CNPJ / CPF do Transportador da carga
cnpj_emba	0	string(30)	Não	CNPJ do Embarcador da carga
viag_numero_manifesto	0	string(100)	Não	Número do manifesto da carga
viag_numero_nf	0	string(100)	Não	Número da nota fiscal vinculada
viag_asn	0	string(20)	Não	Número da ASN vinculada
viag_pedido_revendedor	0	string(20)	Não	Número do pedido do revendedor
viag_valor_merc_especifica	0	float	Não	Valor de mercadoria específica
viag_valor_merc_nao_especifica	0	float	Não	Valor de mercadoria não específica
viag_previsao_inicio	0	datetime (01/06/2015 00:00:00)	Não	Data/hora de previsão de início
viag_previsao_fim	0	datetime (01/06/2015 00:00:00)	Não	Data/hora de previsão de fim
viag_valor_carga	0	float	Não	Valor total da carga
viag_valor_ddr	0	float	Não	Valor DDR
viag_peso_total	0	float	Não	Peso total da carga
viag_altura_carga	0	float	Não	Altura da carga
viag_largura_carga	0	float	Não	Largura da carga
viag_comprimento_carga	0	float	Não	Comprimento da carga
viag_distancia	0	float	Não	Distancia da viagem em KM
viag_codigo_pai	0	integer	Não	Código da viagem pai
viag_descricao_carga	0	string(500)	Não	Descrição da carga
viag_observacao	0	string(500)	Não	Observação da viagem
viag_justificativa_liberacao	0	string(500)	Não	Justificativa de liberação da viagem
viag_compra_pedagio	0	integer	Não	Indica se deve ou não realizar a compra de vale pedágio (1=Realiza a compra, se configurado no PGR da viagem, 0=Não realiza a compra, mesmo se configurado no PGR da viagem)
ignorar_regras_pgrs	0	lista (array)	Não	Lista de itens de PGR que devem ser ignorados na validação do PGR. Para conferir quais itens podem ser ignorados, consulte a equipe técnica Trafegus.
veiculos	0	lista (array)	Sim	Informações dos veículos, podendo associar vários neste array
placa	1	string(10)	Sim	Placa dos veículos da viagem
nro_liberacao	1	string(50)	Não	Número de liberação do veículo
escolta	1	string(1)	Não	Veículo de escolta (S/N)
quantidade_embarcada	0	inteiro	Não	Quantidade embarcada no veiculo
motoristas	0	lista (array)	Sim	Informações dos motoristas, podendo associar vários neste array
cpf_moto	1	string(20)	Não	CPF do motorista da viagem
nro_liberacao	1	integer	Não	Número de liberação do motorista
viag_quantidade_volume	0	integer	Não	Quantidade de volumes
viag_data_solicitacao_licenca	0	datetime (01/06/2015 00:00)	Não	Data de solicitação de licença e/ou serviço legal
contatos	1	lista (array)	Não	Contatos do motorista, podendo associar vários neste array
codigo	1	inteiro	Não	Código do contato, para fazer alterações no contato
email	1	string(100)	Não	Email do contato
fone1	1	string(30)	Não	Telefone do contato
radio	1	string(50)	Não	Radio do contato
ajudantes	0	lista (array)	Não	Ajudantes, podendo associar vários neste array
cpf_ajudante	1	string(20)	Não	CPF do ajudante
nro_liberacao	1	integer	Não	número de liberação
contatos	1	lista (array)	Não	Contatos do ajudante, podendo associar vários neste array
codigo	1	inteiro	Não	Código do contato, para fazer alterações no contato
email	1	string(100)	Não	Email do contato
fone1	1	string(30)	Não	Telefone do contato
radio	1	string(50)	Não	Radio do contato
terminais	0	lista (array)	Não	Terminais da viagem, podendo associar vários neste array
term_numero_terminal	1	string(30)	Não	Número do Terminal
tecn_tecnologia	1	string(50)	Não	Tecnologia
tope_descricao	1	string(50)	Não	Tipo de operacao
tipos_operacoes	0	lista (array)	Não	Tipos de operações da viagem, podendo associar vários neste array
tipos_produtos	0	lista (array)	Não	Tipos de produtos da viagem, podendo associar vários neste array
produto	1	string(50)	Não	Tipo de produto
valor	1	float	Não	Valor do produto na viagem
alterar_pgr_edicao_sm	0	string(1)	Não	Ignora o PGR atual da viagem e o valor do campo viag_pgpg_codigo, selecionando um novo PGR automaticamente
campos_adicionais_viagem	0	objeto	Não	Lista de campos adicionais da viagem com nomes dinâmicos, escolhidos pelo cliente
campo_extra_1	1	string	Não	Campo personalizado 1
campo_extra_2	1	string	Não	Campo personalizado 2
campo_extra_n	1	string	Não	Campo personalizado N (quantidade ilimitada de campos com nomes personalizados)
temperatura	0	objeto	Não	Controle de temperatura
descricao	1	string(100)	Não	Descricão da temperatura
de	1	integer	Não	Faixa inicial de temperatura
ate	1	integer	Não	Faixa final de temperatura
sensores	1	integer	Não	Informar 0 para aplicar a todos os sensores
sensor_01	1	string(1)	Não	Aplica faixa para sensor 1 (S/N)
sensor_02	1	string(1)	Não	Aplica faixa para sensor 2 (S/N)
sensor_03	1	string(1)	Não	Aplica faixa para sensor 3 (S/N)
sensor_04	1	string(1)	Não	Aplica faixa para sensor 4 (S/N)
sensor_05	1	string(1)	Não	Aplica faixa para sensor 5 (S/N)
sensor_06	1	string(1)	Não	Aplica faixa para sensor 6 (S/N)
sensor_07	1	string(1)	Não	Aplica faixa para sensor 7 (S/N)
sensor_08	1	string(1)	Não	Aplica faixa para sensor 8 (S/N)
sensor_09	1	string(1)	Não	Aplica faixa para sensor 9 (S/N)
sensor_10	1	string(1)	Não	Aplica faixa para sensor 10 (S/N)
rota_codigo	0	integer	Sim	Código da Rota
rota_identificador	0	string(20)	Não	Identificador da Rota
coordenadas	0	string	Sim	Polyline criptografada da Rota no formato GoogleMaps
rota_descricao	0	string	Sim	Descricao da Rota
origem	0	objeto	Sim	Informações da origem da viagem
vloc_descricao	1	string(200)	Sim	Descrição do local de origem
logradouro	1	string(200)	Não	Logradouro da origem
complemento	1	string(100)	Não	Complemento do logradouro da origem
cep	1	string(8)	Não	CEP do Logradouro (Usar como auxilio para não duplicar)
numero	1	string(10)	Não	Nro do logradouro da origem
bairro	1	string(100)	Não	Bairro da origem
cida_descricao_ibge	1	string(100)	Não	Cidade da origem ou código do IBGE (da cidade)
sigla_estado	1	string(2)	Não	Sigla UF (estado da cidade)
pais	1	string(50)	Não	País
refe_latitude	1	float	Não	Latitude da origem
refe_longitude	1	float	Não	Longitude da origem
refe_raio	1	float	Não	Raio do local de origem
refe_km	1	string(10)	Não	KM da rodovia do local de origem
refe_bandeira	1	string(50)	Não	Bandeira do local de oriem
associar_transportador	1	string(1)	Não	Associar como Origem do Transportador (S/N)
contatos	1	lista (array)	Não	Contatos do local de origem
codigo	1	inteiro	Não	Código do contato, para fazer alterações no contato
email	2	string(100)	Não	Email do contato
fone1	2	string(30)	Não	Telefone do contato
radio	2	string(50)	Não	Radio do contato
viag_data_consolidacao	1	datetime (01/06/2015 00:00:00)	Não	Data de consolidação da viagem
previsao_chegada	1	datetime (01/06/2015 00:00:00)	Não	Previsão de chegada no origem
previsao_inicio_espera	1	datetime (01/06/2015 00:00:00)	Não	Previsão de início de espera no origem
previsao_fim_espera	1	datetime (01/06/2015 00:00:00)	Não	Previsão de fim de espera no origem
previsao_inicio_carregamento	1	datetime (01/06/2015 00:00:00)	Não	Previsão de início de carregamento no origem
previsao_fim_carregamento	1	datetime (01/06/2015 00:00:00)	Não	Previsão de fim de carregamento no origem
previsao_inicio_descarregamento	1	datetime (01/06/2015 00:00:00)	Não	Previsão de início de descarregamento no origem
previsao_fim_descarregamento	1	datetime (01/06/2015 00:00:00)	Não	Previsão de fim de descarregamento no origem
previsao_saida	1	datetime (01/06/2015 00:00:00)	Não	Previsão de saida na origem
vloc_data_agenda	1	datetime (01/06/2015 00:00:00)	Não	Data de agendamento na origem
conhecimentos	1	lista (array)	Não	Informações dos conhecimentos da viagem
campos_adicionais_conhecimento	2	objeto	Não	Lista de campos adicionais do conhecimento com nomes dinâmicos, escolhidos pelo cliente
campo_extra_1	3	string	Não	Campo personalizado 1
campo_extra_2	3	string	Não	Campo personalizado 2
campo_extra_n	3	string	Não	Campo personalizado N (quantidade ilimitada de campos com nomes personalizados)
vlco_numero	2	string(50)	Sim	Número do conhecimento
vlco_cpf_cnpj	2	string(30)	Não	CNPJ/CPF do cliente do conhecimento
vlco_valor	2	float	Sim	Valor do conhecimento
notas_fiscais	2	lista (array)	Não	Informações de notas fiscais do conhecimento
vnfi_numero	3	string(20)	Sim	Número da nota fiscal
vnfi_pedido	3	string(20)	Não	Número do pedido do cliente
vnfi_valor	3	float	Sim	Valor da nota fiscal
vnfi_data_fat	3	datetime (01/06/2015 00:00:00)	Não	Data do faturamento da nota fiscal
vnfi_observacao	3	string(5000)	Não	Observação da nota fiscal
produtos	3	lista (array)	Não	Produtos da nota fiscal
vpro_descricao	4	string(50)	Sim	Descrição do produto da nota fiscal
vpro_tipo	4	string(50)	Sim	Tipo de produto
vpro_quantidade	4	integer	Sim	Quantidade do produto
vpro_valor	4	float	Sim	Valor do produto
remetente	3	objeto	Não	Remetente da nota fiscal
refe_descricao	4	string(200)	Sim	Descrição do remetente
refe_latitude	4	float	Não	Latitude do local
refe_longitude	4	float	Não	Longitude do local
cida_descricao_ibge	4	string(100)	Não	Cidade da origem ou código do IBGE (da cidade)
cep	4	string(8)	Não	CEP do Logradouro (Usar como auxilio para não duplicar)
destinatario	3	objeto	Não	Destinatário da nota fiscal
refe_descricao	4	string(200)	Sim	Descrição do destinatário
refe_latitude	4	float	Não	Latitude do local
refe_longitude	4	float	Não	Longitude do local
cida_descricao_ibge	4	string(100)	Não	Cidade da origem ou código do IBGE (da cidade)
cep	4	string(8)	Não	CEP do Logradouro (Usar como auxilio para não duplicar)
documento	1	string	Não	Documento do dono do local
descricao	1	string	Não	Descrição do local (caso for cadastradado uma nova referência na associação de empresa da referência - se não for informado é utilizado o nome da empresa)
cnpj	1	integer	Não	CNPJ da Empresa origem
locais	1	lista (array)	Não	Locais da viagem, podendo associar vários neste array
vloc_descricao	1	string(200)	Sim	Descrição do local de origem
ignorarRoteirizacao	1	boolean	Não	Define se o local será ignorado na roteirização
tipo_parada	1	integer	Não	Informar o código do "tipo de parada" do local "Ex: 1 - Se o local for uma Parada, 2 - Se o local for uma Coleta...", consultar o método "Parâmetros tipo de parada" presente na documentação
tipo_local	1	integer	Não	Informar o código do "tipo de local" do local "Ex: 1 - Se o local for uma Area de risco, 2 - Se o local for um ponto permitido...", consultar o método "Parâmetros tipo de local" presente na documentação
logradouro	1	string(200)	Não	Logradouro da origem
complemento	1	string(100)	Não	Complemento do logradouro da origem
cep	1	string(8)	Não	CEP do Logradouro (Usar como auxilio para não duplicar)
numero	1	string(10)	Não	Nro do logradouro da origem
bairro	1	string(100)	Não	Bairro da origem
cida_descricao_ibge	1	string(100)	Não	Cidade da origem ou código do IBGE (da cidade)
sigla_estado	1	string(2)	Não	Sigla UF (estado da cidade)
pais	1	string(50)	Não	País
refe_latitude	1	float	Não	Latitude da locais
refe_longitude	1	float	Não	Longitude da locais
refe_raio	1	float	Não	Raio do local de locais
refe_km	1	string(10)	Não	KM da rodovia do local de locais
refe_bandeira	1	string(50)	Não	Bandeira do local de locais
associar_transportador	1	string(1)	Não	Associar como locais do Transportador (S/N)
contatos	1	lista (array)	Não	Contatos do local de locais
codigo	2	inteiro	Não	Código do contato, para fazer alterações no contato
email	2	string(100)	Não	Email do contato
fone1	2	string(30)	Não	Telefone do contato
radio	2	string(50)	Não	Radio do contato
previsao_chegada	2	datetime (01/06/2015 00:00:00)	Não	Previsão de chegada no locais
previsao_inicio_espera	2	datetime (01/06/2015 00:00:00)	Não	Previsão de início de espera no locais
previsao_fim_espera	2	datetime (01/06/2015 00:00:00)	Não	Previsão de fim de espera no locais
previsao_inicio_carregamento	2	datetime (01/06/2015 00:00:00)	Não	Previsão de início de carregamento no locais
previsao_fim_carregamento	2	datetime (01/06/2015 00:00:00)	Não	Previsão de fim de carregamento no locais
previsao_inicio_descarregamento	2	datetime (01/06/2015 00:00:00)	Não	Previsão de início de descarregamento no locais
previsao_fim_descarregamento	2	datetime (01/06/2015 00:00:00)	Não	Previsão de fim de descarregamento no locais
previsao_saida	2	datetime (01/06/2015 00:00:00)	Não	Previsão de saida na locais
vloc_data_agenda	1	datetime (01/06/2015 00:00:00)	Não	Data de agendamento nos locais
conhecimentos	1	lista (array)	Não	Informações dos conhecimentos da viagem
vlco_numero	2	string(50)	Sim	Número do conhecimento
vlco_cpf_cnpj	2	string(30)	Não	CNPJ/CPF do cliente do conhecimento
vlco_valor	2	float	Sim	Valor do conhecimento
notas_fiscais	2	lista (array)	Não	Informações de notas fiscais do conhecimento
campos_adicionais_nf	3	objeto	Não	Lista de campos adicionais da nota fiscal com nomes dinâmicos, escolhidos pelo cliente
campo_extra_1	4	string	Não	Campo personalizado 1
campo_extra_2	4	string	Não	Campo personalizado 2
campo_extra_n	4	string	Não	Campo personalizado N (quantidade ilimitada de campos com nomes personalizados)
vnfi_numero	3	string(20)	Sim	Número da nota fiscal
vnfi_pedido	3	string(20)	Não	Número do pedido do cliente
vnfi_valor	3	float	Sim	Valor da nota fiscal
vnfi_data_fat	3	datetime (01/06/2015 00:00:00)	Não	Data do faturamento da nota fiscal
vnfi_observacao	3	string(5000)	Não	Observação da nota fiscal
produtos	3	lista (array)	Não	Produtos da nota fiscal
vpro_descricao	4	string(50)	Sim	Descrição do produto da nota fiscal
vpro_tipo	4	string(50)	Sim	Tipo de produto
vpro_quantidade	4	integer	Sim	Quantidade do produto
vpro_valor	4	float	Sim	Valor do produto
documento	1	string	Não	Documento do dono do local
descricao	1	string	Não	Descrição do local (caso for cadastradado uma nova referência na associação de empresa da referência - se não for informado é utilizado o nome da empresa)
cnpj	1	integer	Não	CNPJ da Empresa do local
destino	0	objeto	Sim	Informações do destino da viagem
vloc_descricao	1	string(200)	Sim	Descrição do local de destino
logradouro	1	string(200)	Não	Logradouro da destino
complemento	1	string(100)	Não	Complemento do logradouro da destino
cep	1	string(8)	Não	CEP do Logradouro (Usar como auxilio para não duplicar)
numero	1	string(10)	Não	Nro do logradouro da destino
bairro	1	string(100)	Não	Bairro da destino
cida_descricao_ibge	1	string(100)	Não	Cidade da destino ou código do IBGE (da cidade)
sigla_estado	1	string(2)	Não	Sigla UF (estado da cidade)
pais	1	string(50)	Não	País
refe_latitude	1	float	Não	Latitude da destino
refe_longitude	1	float	Não	Longitude da destino
refe_raio	1	float	Não	Raio do local de destino
refe_km	1	string(10)	Não	KM da rodovia do local de destino
refe_bandeira	1	string(50)	Não	Bandeira do local de oriem
associar_transportador	1	string(1)	Não	Associar como destino do Transportador (S/N)
contatos	1	lista (array)	Não	Contatos do local de destino
codigo	1	inteiro	Não	Código do contato, para fazer alterações no contato
email	2	string(100)	Não	Email do contato
fone1	2	string(30)	Não	Telefone do contato
radio	2	string(50)	Não	Radio do contato
previsao_chegada	1	datetime (01/06/2015 00:00:00)	Não	Previsão de chegada no destino
previsao_inicio_espera	1	datetime (01/06/2015 00:00:00)	Não	Previsão de início de espera no destino
previsao_fim_espera	1	datetime (01/06/2015 00:00:00)	Não	Previsão de fim de espera no destino
previsao_inicio_carregamento	1	datetime (01/06/2015 00:00:00)	Não	Previsão de início de carregamento no destino
previsao_fim_carregamento	1	datetime (01/06/2015 00:00:00)	Não	Previsão de fim de carregamento no destino
previsao_inicio_descarregamento	1	datetime (01/06/2015 00:00:00)	Não	Previsão de início de descarregamento no destino
previsao_fim_descarregamento	1	datetime (01/06/2015 00:00:00)	Não	Previsão de fim de descarregamento no destino
previsao_saida	1	datetime (01/06/2015 00:00:00)	Não	Previsão de saida no destino
vloc_data_agenda	1	datetime (01/06/2015 00:00:00)	Não	Data de agendamento no destino
conhecimentos	1	lista (array)	Não	Informações dos conhecimentos da viagem
vlco_numero	2	string(50)	Sim	Número do conhecimento
vlco_cpf_cnpj	2	string(30)	Não	CNPJ/CPF do cliente do conhecimento
vlco_valor	2	float	Sim	Valor do conhecimento
notas_fiscais	2	lista (array)	Não	Informações de notas fiscais do conhecimento
vnfi_numero	3	string(20)	Sim	Número da nota fiscal
vnfi_pedido	3	string(20)	Não	Número do pedido do cliente
vnfi_valor	3	float	Sim	Valor da nota fiscal
vnfi_data_fat	3	datetime (01/06/2015 00:00:00)	Não	Data do faturamento da nota fiscal
vnfi_observacao	3	string(5000)	Não	Observação da nota fiscal
produtos	3	lista (array)	Não	Produtos da nota fiscal
vpro_descricao	4	string(50)	Sim	Descrição do produto da nota fiscal
vpro_tipo	4	string(50)	Sim	Tipo de produto
vpro_quantidade	4	integer	Sim	Quantidade do produto
vpro_valor	4	float	Sim	Valor do produto
documento	1	string	Não	Documento do dono do local
descricao	1	string	Não	Descrição do local (caso for cadastradado uma nova referência na associação de empresa da referência - se não for informado é utilizado o nome da empresa)
cnpj	1	integer	Não	CNPJ da Empresa destino
contatos	0	lista (array)	Não	Contatos da viagem
codigo	1	inteiro	Não	Código do contato, para fazer alterações no contato
nome	1	string (100)	Não	Nome do contato
telefone	1	string (30)	Não	Telefone do contato
regioes_urbanas	0	lista (array)	Não	Lista de áreas
area_codigo	1	Inteiro	Sim	Código da Área (Interno)
simular_sm	0	boolean	Não	Define se vai gerar uma SM ou somente fazer uma simulação para gravação dos dados

Observações:
A coluna "Nível" representa o aninhamento das tags do XML/JSON e seus sub-níveis.

Para viagens enviadas sem roteirização automática e sem rota, apenas com os locais, se o geolocalizador não encontrar algum local, este será cadastrado na viagem com latitude e longitude zero e retornará um warning para informação.

Exemplo de envio JSON para o envio de viagens para o sistema Trafegus (Este método permite o envio de várias viagens).

{
    "vincularEmpresaLocal": true, -- flag para executar o vínculo da empresa na referência
    "viagem": [ -- podem ser enviadas várias SM's dentro deste array.
    {
        "viag_codigo_externo": "123",
        "documento_transportador": "54735256000176",
        "cnpj_gr": "53818355000100",
        "viag_ttra_codigo": 1,
        "veiculos": [{
            "placa": "ONX0001"

        }],
        "motoristas": [{
            "cpf_moto": "897701379-87"
        }],
        "terminais": [{
            "term_numero_terminal": "103919",
            "tecn_tecnologia": "SASCAR"
        }],

        "viag_previsao_inicio": "01/05/2019 20:18:02",
        "viag_previsao_fim": "10/05/2019 20:18:02",
        "alterar_pgr_edicao_sm": "N",
        "campos_adicionais_viagem": {
           "teste": 123
        },
        "viag_pgpg_codigo": "11",
        "viag_valor_carga": 525100.22,
        "viag_numero_nf":7777777777777777,
        "viag_asn": 888888888888888,
        "viag_altura_carga": "13",
        "viag_largura_carga": "13",
        "viag_comprimento_carga": "13",
        "viag_quantidade_volume": "131",
        "viag_data_solicitacao_licenca": "02/10/2023 20:18",
        "rota_codigo": 123,
        "regioes_urbanas": [
            {
                "area_codigo": 10
            },
            {
                "area_codigo": 20
            }
        ],
        "viag_pedido_revendedor": "11111111111",
        "origem": {
            "vloc_descricao": "GUATAMBU",
            "logradouro": "00950080713",
            "complemento": "4323",
            "cep": "0095008",
            "numero": "",
            "bairro": "TREVO",
            "cida_descricao_ibge": "Guatambu",
            "sigla_estado": "SC",
            "pais": "BRASIL",
            "refe_latitude": "-27.1373161",
            "refe_longitude": "-52.7802818",
            "refe_raio": "500",
            "associar_transportador": "S",
            "documento": "99999999999999",
            "descricao": "MERCADO GUATAMBU",
            "cnpj": "44450922000176"
        },
        "locais": [{
            "vloc_sequencia": 2,
            "vloc_descricao": "P. ALFA - CHAPECO/SC",
            "tipo_parada": 3,
            "tipo_local": 6,
            "logradouro": "00950080713",
            "complemento": "323",
            "cep": "0095008",
            "numero": "",
            "bairro": "TREVO",
            "cida_descricao_ibge": "4204202",
            "sigla_estado": "SC",
            "pais": "BRASIL",
            "refe_latitude": "-27.1048747",
            "refe_longitude": "-52.7802818",
            "refe_raio": "500",
            "associar_transportador": "S",
            "documento": "77777777777777",
            "descricao": "POSTO ALFA",
            "cnpj": "44450922000176",
            "conhecimentos": [
                        {
                            "vlco_numero": "conhe2",
                            "vlco_valor": "1.00",
                            "vlco_cpf_cnpj": "54735256000176",
                            "campos_adicionais_conhecimento": {
                                "teste": 222
                            },
                            "notas_fiscais": [
                                {
                                    "campos_adicionais_nf": {
                                        "teste": 333
                                    },
                                    "vnfi_numero": "nf23",
                                    "vnfi_pedido": "pedido",
                                    "vnfi_valor": "1.00",
                                    "vnfi_data_fat": "2018-07-03 00:00:00",
                                    "vnfi_observacao": "OBSERVACAO",
                                    "remetente": {
                                        "refe_descricao": "ARENA CONDA",
                                        "refe_latitude": "-27.0707338178",
                                        "refe_longitude": "-52.6269900798",
                                        "cida_descricao_ibge": "CHAPECO",
                                        "cep": null
                                    },
                                    "destinatario": {
                                        "refe_descricao": "P. SAMUARA",
                                        "refe_latitude": "-29.0707338178",
                                        "refe_longitude": "-54.6269900798",
                                        "cida_descricao_ibge": "CHAPECO",
                                        "cep": null
                                    }
                                }
                            ]
                        }
                    ]


        }],
        "destino": {
            "vloc_descricao": "CENTRO CHAPECO",
            "logradouro": "00950080713",
            "complemento": "3233",
            "cep": "0095008",
            "numero": "45E",
            "bairro": "CENTRO",
            "cida_descricao_ibge": "4204202",
            "sigla_estado": "SC",
            "pais": "BRASIL",
            "refe_latitude": "-27.1048758",
            "refe_longitude": "-52.6139045",
            "refe_raio": "500",
            "associar_transportador": "S",
            "documento": "88888888888888",
            "descricao": "MERCADO CHAPECO",
            "cnpj": "44450922000176",
             "conhecimentos": [
                    {
                        "vlco_numero": "numerocone1",
                        "vlco_valor": "18895891.00",
                        "vlco_cpf_cnpj": "54735256000176",
                        "notas_fiscais": [
                            {
                                "vnfi_numero": "nf2",
                                "vnfi_pedido": "455",
                                "vnfi_valor": "874.00",
                                "vnfi_data_fat": "2018-07-03 00:00:00",
                                "vnfi_observacao": "TESTE",
                                "remetente": {
                                    "refe_descricao": "ARENA CONDA",
                                    "refe_latitude": "-27.0707338178",
                                    "refe_longitude": "-52.6269900798",
                                    "cida_descricao_ibge": "CHAPECO",
                                    "cep": null
                                },
                                "destinatario": {
                                    "refe_descricao": "P. SAMUARA",
                                    "refe_latitude": "-29.0707338178",
                                    "refe_longitude": "-54.6269900798",
                                    "cida_descricao_ibge": "CHAPECO",
                                    "cep": null
                                }
                            },
                            {
                                "vnfi_numero": "nf1",
                                "vnfi_pedido": "321",
                                "vnfi_valor": "18895017.00",
                                "vnfi_data_fat": "2018-07-03 00:00:00",
                                "vnfi_observacao": "TESTE",
                                "remetente": {
                                    "refe_descricao": "ARENA CONDA",
                                    "refe_latitude": "-27.0707338178",
                                    "refe_longitude": "-52.6269900798",
                                    "cida_descricao_ibge": "CHAPECO",
                                    "cep": null
                                },
                                "destinatario": {
                                    "refe_descricao": "P. SAMUARA",
                                    "refe_latitude": "-29.0707338178",
                                    "refe_longitude": "-54.6269900798",
                                    "cida_descricao_ibge": "CHAPECO",
                                    "cep": null
                                }
                            }
                        ]
                    }
                ]
        }
    }]
}

Detalhamento de validações de Preenchimento:

Somente devem ser enviadas solicitações de monitoramento (SM's) de segurados . Sendo eles e transportador e/ou o embarcador da viagem.
O preenchimento do tipo de transporte não é obrigatório
É necessário o preenchimento de ao menos um veículo e um motorista para a SM.
O preenchimento de um terminal não é obrigatório. Caso não for informado será utilizado o do cadastro do veículo. Caso este não possua um, então será retornado erro.
O preenchimento da informação de tipo de operação pode ser fixo confome a regra: TRANSFERENCIA (para viagens interestaduais) e DISTRIBUICAO (para viagens dentro do mesmo estado).
A data de previsão de início da viagem não pode ser retroativa (anterior a data/hora atual).
A data de previsão de fim não pode ser menor que a data de previsão de início.
As regras (PGR) para controle dos indicadores serão preenchidas no momento da inclusão da SM conforme o CNPJ do Transportador + Tipo de Transporte + Valor da Carga.
Quanto ao preenchimento da origem, destino e dos locais da viagem, devem ser informdadas as Latitudes / Longitudes ou então um endereço válido (Logradouro, cep, número, bairro, cidade, uf).
Os locais de origem, o destino e os locais da viagem serão vinculados ao transportador / embarcador para controles da viagem.
Ao ser informado a flag vincularEmpresaLocal, os campos documento, refe_latitude e refe_longitude para cada local se tornam obrigatórios. Sendo o primeiro para buscar se já existe uma referência cadastrada e os demais para efetuar um novo cadastro.
Caso enviada a tag "temperatura[n].descricao" com uma descrição não existente, irá validar se possui dados de Valor Mínimo e Valor Máximo e Sensor Controlado. Se existirem estes dados, irá cadastrar automaticamente uma nova faixa e vinculá-la na SM. Caso não existirem estes dados, irá barrar o cadastro da SM, mesmo que exista uma faixa vinculada no terminal da viagem.

Possíveis erros de cadastro

        {
    "sucesso": [],
    "success": [],
    "error": [
        {
            "cod_status": "0",
            "valor": "5472235256000176",
            "campo": "documento_transportador",
            "mensagem": "cnpj nao encontrado"
        },{
            "cod_status": "0",
            "valor": "8972701379-87",
            "campo": "cpf_moto",
            "mensagem": "cpf do motorista nao encontrado"
        },{
            "cod_status": "0",
            "valor": null,
            "campo": "motoristas",
            "mensagem": "necessario informar um motorista"
        },{
            "cod_status": "0",
            "valor": null,
            "campo": "veiculos",
            "mensagem": "necessario informar um veiculo"
        },
        {
            "cod_status": "0000",
            "valor": "",
            "campo": null,
            "mensagem": "Erro ao cadastrar viagem"
        }
    ]
}

Possíveis erros de PGR

        {
    "sucesso": [],
    "success": [],
    "error": [
        {
            "cod_status": "0",
            "valor": "",
            "campo": "veiculos",
            "mensagem": "O PGR selecionado nao permite criar uma SM sem um checklist valido"
        },
        {
            "cod_status": "0",
            "valor": "null",
            "campo": "PESQUISAS",
            "mensagem": " CHECKLIST, NAO POSSUI(EM) PESQUISA(S) OU NAO POSSUI(EM) JUSTIFICATIVA(S) VALIDA(S)"
        },
        {
            "cod_status": "0",
            "valor": "",
            "campo": "veiculos",
            "mensagem": "O PGR selecionado não permite criar uma SM quando o veículo XXXX não está em conformidade!",
            "motivos": ["Borracharia", "Descontaminação"]
          },
          {
            "cod_status": "0",
            "valor": "",
            "campo": "Motorista",
            "mensagem": "O PGR selecionado não permite criar uma SM quando o motorista EVTO BOGIS não está em conformidade!",
            "motivos": [
              "Descumprimento das Regras de Plano de Gerenciamento",
              "Dossiê Motorista"
            ],
            "motivo_interno": "motorista não cumpriu reciclagem",
            "observacao": "Não aceitar a viagem"
          },
    ]
}

EnviarTransportador

[POST] http://ip.do.cliente:porta/ws_rest/public/api/transportador

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Tipo	Obrigatório	Descrição
documento_transportador	texto (30)	Sim	CPF / CNPJ do transportador
tipo_pessoa	texto (4)	Não	Tipo da pessoa ("pfis" para pessoa física ou "pjur" para pessoa jurídica)
nome	texto (50)	Sim	Nome do Transportador
razao_social	texto (100)	Não	Razão social do Transportador
ie_rg	texto (20)	Não	RG (pessoa fisica) ou IE (pessoa jurídica)
logradouro	texto (200)	Não	Descrição do Logradouro
cep	texto (8)	Não	CEP do Logradouro
numero	texto (50)	Não	Número do Logradouro
complemento	texto (100)	Não	Descrição do Bairro do Logradouro
bairro	texto (100)	Não	Descrição do Bairro do Logradouro
cidade	texto (100)	Não	Cidade da origem ou código do IBGE (conforme tabela padrão do IBGE)
sigla_estado	texto (2)	Não	Sigla do Estado do Logradouro
pais	texto (50)	Não	Pais
documento_matriz	texto (30)	Não	CPF / CNPJ da matriz do Transportador
tipo_pessoa_matriz	texto (4)	Não	Tipo da pessoa ("pfis" para pessoa física ou "pjur" para pessoa jurídica)
senha	texto (20)	Não	Senha do transportador
roteiriza_automatico_sm	inteiro	Não	Utiliza roterização automática na SM (0 não, 1 sim)
associa_motorista_sm	inteiro	Não	Associar motoristas automaticamente ao Transportador da SM (0 não, 1 sim). Informar "1" por padrão.
associa_veiculo_sm	inteiro	Não	Associar veiculos automaticamente ao Transportador da SM (0 não, 1 sim). Informar "1" por padrão.
contatos	lista (array)	Não	Contatos do motorista
email	string(100)	Não	Email do contato
fone1	string(30)	Não	Telefone do contato
texto	string(100)	Não	Nome do contato
estacao_rastreamento_padrao	integer	Não	Estação de rastreamento do transportador
associar_locais_permitidos_viagem	integer	Não	Associação de locais permitidos na viagem (0 não, 1 sim). Padrão 0.
cerca_eletronica_associacao_locais	integer	Não	Cerca Eletrônica para associação de locais (em metros). Padrão 500.
raioOrigemSm	integer	Não	Raio da origem para criar a SM (metros).
embarcadores	lista (array)	Não	Embarcadores a vincular

Requisição para envio dos dados de Transportador:

{
    "transportador": [ -- podem ser enviados vários transportadores dentro deste array.
    {
        "documento_transportador": "42088421000166",
        "tipo_pessoa": "pjur",
        "nome": "CONTATTO",
        "razao_social": "CONTATTO",
        "ie_rg": null,
        "logradouro": null,
        "cep": null,
        "numero": null,
        "complemento": null,
        "bairro": null,
        "cidade": null,
        "sigla_estado": null,
        "pais": null,
        "documento_matriz": null,
        "tipo_pessoa_matriz": null,
        "senha": null,
        "roteiriza_automatico_sm": 1,
        "associa_motorista_sm": 1,
        "associa_veiculo_sm": 1,
        "associar_locais_permitidos_viagem": 1,
        "cerca_eletronica_associacao_locais": 500,
        "embarcadores" : [
            {
            "documento_embarcador": "81832254000178"
            }
        ]
    }]
}

Retorno em caso de Sucesso:


{
    "sucesso": [
        {
                "cod": "0",
                "codigo_transportador": 3082044,
                "mensagem": "operacao realizada com sucesso"
        }
    ],
    "success": [
        {
                "cod": "0",
                "codigo_transportador": 3082044,
                "mensagem": "operacao realizada com sucesso"
        }
    ],
    "error": []
}

Retorno em caso de Erro:

 {
    "success": [],
        "sucesso": [],

    "error": [
        {
            "cod": "1",
            "valor": "cnpj",
            "campo": "documento_transportador",
            "mensagem": "necessario informar um documento do transportador"
        }{
            "cod": "2",
            "valor": "",
            "campo": "documento_matriz",
            "mensagem": "matriz com cnpj nao encontrado"
        }{
            "cod": "3",
            "valor": "",
            "campo": "documento_matriz",
            "mensagem": "matriz com cpf nao encontrado"
        }{
            "cod": "4",
            "valor": "",
            "campo": "cidade",
            "mensagem": "cidade nao encontrada"
        }{
            "cod": "5",
            "valor": "",
            "campo": "logradouro, cep",
            "mensagem": "logradouro ou cep obrigatorio se informado cidade, estado, pais ou bairro"
        }{
            "cod": "6",
            "valor": "",
            "campo": "estado",
            "mensagem": "estado nao encontrado"
        }{
            "cod": "7",
            "valor": "",
            "campo": "pais",
            "mensagem": "pais nao encontrado"
        }{
            "cod": "8",
            "valor": "",
            "campo": "pgr_padrao",
            "mensagem": "pgr não encontrado"
        }{
            "cod": "9",
            "valor": "",
            "campo": "estacao_gr_padrao",
            "mensagem": "estacao gr não encontrado"
        }{
            "cod": "10",
            "valor": "",
            "campo": "nome",
            "mensagem": "necessario informar um nome"
        }{
            "cod": "11",
            "valor": "",
            "campo": "documento_transportador",
            "mensagem": "cnpj invalido"
        }{
            "cod": "12",
            "valor": "",
            "campo": "documento_transportador",
            "mensagem": "cnpj ja cadastrado"
        }{
            "cod": "13",
            "valor": "",
            "campo": "documento_transportador",
            "mensagem": "cpf invalido"
        }{
            "cod": "14",
            "valor": "",
            "campo": "documento_transportador",
            "mensagem": "cpf ja cadastrado"
        }{
            "cod": "15",
            "valor": "",
            "campo": "documento_transportador",
            "mensagem": "Erro ao cadastrar transportador"
        }
    ]
}

EnviarEmbarcador

[POST] http://ip.do.cliente:porta/ws_rest/public/api/embarcador

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Tipo	Obrigatório	Descrição
cnpj_embarcador	texto (30)	Sim	CNPJ do embarcador
nome	texto (50)	Sim	Nome do Embarcador
razao_social	texto (100)	Não	Razão social do Embarcador
ie	texto (20)	Não	Inscricao estadual do Embarcador
logradouro	texto (200)	Não	Descrição do Logradouro
cep	texto (8)	Não	CEP do Logradouro
numero	texto (50)	Não	Número do Logradouro
complemento	texto (100)	Não	Descrição do Bairro do Logradouro
bairro	texto (100)	Não	Descrição do Bairro do Logradouro
cidade	texto (100)	Não	Cidade da origem ou código do IBGE (conforme tabela padrão do IBGE)
sigla_estado	texto (2)	Não	Sigla do Estado do Logradouro
pais	texto (50)	Não	Pais
cnpj_matriz	texto (30)	Não	CNPJ da matriz do Embarcador
roteiriza_automatico_sm	inteiro	Não	Utiliza roterização automática na SM (0 não, 1 sim)
associa_motorista_sm	inteiro	Não	Associar motoristas automaticamente ao Transportador da SM (0 não, 1 sim). Informar "1" por padrão.
associa_veiculo_sm	inteiro	Não	Associar veiculos automaticamente ao Transportador da SM (0 não, 1 sim). Informar "1" por padrão.
estacao_rastreamento_padrao	integer	Não	Estação de rastreamento do Embarcador
associar_locais_permitidos_viagem	integer	Não	Associação de locais permitidos na viagem (0 não, 1 sim). Padrão 0.
obriga_tipo_operacao_sm	integer	Não	Obrigar Tipo de Operação no Cadastro de SM (0 não, 1 sim). Padrão 0.
cerca_eletronica_associacao_locais	integer	Não	Cerca Eletrônica para associação de locais (em metros). Padrão 500.
tempo_limite_previsao_inicio_viagem_retroativa	integer	Não	Tempo Limite para Previsão de Início de Viagens Retroativas (em minutos).
tempo_limite_previsao_inicio_viagem_futura	integer	Não	Tempo Limite para Previsão de Início de Viagens Futuras (em minutos)
raioOrigemSm	integer	Não	Raio da origem para criar a SM (metros).

Requisição para envio dos dados de Embarcador:

{
    "embarcador": [ -- podem ser enviados vários embarcadores dentro deste array.
        {
            "cnpj_embarcador": "47362387000190",
            "nome": "WS A1 EMBA",
            "razao_social": "WS REST",
            "ie": "WS REST",
            "logradouro": "WS REST",
            "cep": "WS REST",
            "numero": "1212",
            "complemento": "WS REST",
            "bairro": "WS REST",
            "DocumentoMatriz":  null,
            "senha": "2222",
            "roteiriza_automatico_sm": 1,
            "associa_motorista_sm": 1,
            "associa_veiculo_sm": 1,
            "associar_locais_permitidos_viagem": 0,
            "obriga_tipo_operacao_sm": 0,
            "cerca_eletronica_associacao_locais": 500,
            "tempo_limite_previsao_inicio_viagem_retroativa": 60,
            "tempo_limite_previsao_inicio_viagem_futura": 60
        }
    ]
}

Retorno em caso de Sucesso:


{
    "sucesso": [
        {
                "cod": "0",
                "codigo_embarcador": cod,
                "mensagem": "operacao realizada com sucesso"
        }
    ],
    "success": [
        {
                "cod": "0",
                "codigo_embarcador": cod,
                "mensagem": "operacao realizada com sucesso"
        }
    ],
    "error": []
}

Retorno em caso de Erro:

{
    "success": [],
        "sucesso": [],
    "error": [
        {
            "cod": "1",
            "valor": "cnpj",
            "campo": "cnpj_embarcador",
            "mensagem": "necessario informar um cnpj do embarcador"
        }{
            "cod": "2",
            "valor": "",
            "campo": "cnpj_matriz",
            "mensagem": "cnpj matriz nao encontrado"
        }{
            "cod": "3",
            "valor": "",
            "campo": "cidade",
            "mensagem": "cidade nao encontrada"
        }{
            "cod": "4",
            "valor": "",
            "campo": "logradouro, cep",
            "mensagem": "logradouro ou cep obrigatorio se informado cidade, estado, pais ou bairro"
        }{
            "cod": "5",
            "valor": "",
            "campo": "sigla_estado",
            "mensagem": "estado nao encontrado"
        }{
            "cod": "6",
            "valor": "",
            "campo": "pais",
            "mensagem": "pais nao encontrado"
        }{
            "cod": "7",
            "valor": "",
            "campo": "pgr_padrao",
            "mensagem": "pgr não encontrado"
        }{
            "cod": "8",
            "valor": "",
            "campo": "cnpj_embarcador",
            "mensagem": "cnpj ja cadastrado"
        }{
            "cod": "9",
            "valor": "",
            "campo": "estacao_gr_padrao",
            "mensagem": "estacao gr nao encontrado"
        }{
            "cod": "10",
            "valor": "",
            "campo": "nome",
            "mensagem": "necessario informar um nome"
        }{
            "cod": "11",
            "valor": "",
            "campo": "cnpj_embarcador",
            "mensagem": "cnpj invalido"
        }{
            "cod": "12",
            "valor": "",
            "campo": "null",
            "mensagem": "Erro ao cadastrar embarcador"
        }
    ]
}

EnviarMotorista

[POST] http://ip.do.cliente:porta/ws_rest/public/api/motorista

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
cpf_motorista	0	texto (20)	Sim	CPF do motorista
nome	0	texto (50)	Sim	Nome do Motorista
rg	0	texto (20)	Não	RG do motorista
numero_pis	0	texto (20)	Não	PIS do motorista
sexo	0	texto (1)	Não	Sexo do(a) motorista ('M' ou 'F')
matricula	0	texto (50)	Não	Matrícula
empresa_contratante	0	texto (20)	Não	Cód. da Empresa Contratante
documento_gestor	0	texto (30)	Não	CPF do Gestor do Motorista
logradouro	0	texto (200)	Não	Descrição do Logradouro
cep	0	texto (8)	Não	CEP do Logradouro
numero	0	texto (50)	Não	Número do Logradouro
complemento	0	texto (100)	Não	Descrição do Bairro do Logradouro
bairro	0	texto (100)	Não	Descrição do Bairro do Logradouro
cidade	0	texto (100)	Não	Cidade da origem ou código do IBGE (conforme tabela padrão do IBGE)
sigla_estado	0	texto (2)	Não	Sigla do Estado do Logradouro
pais	0	texto (50)	Não	Pais
nro_cnh	0	texto (25)	Não	Número da CNH do motorista
categoria_cnh	0	texto (10)	Não	Categoria da CNH do motorista
validade_cnh	0	datetime (01/06/2015 00:00:00)	Não	Validade CNH do motorista
senha	0	texto (15)	Não	Senha do motorista
vigilante	0	texto (1)	Não	Vigilante (S/N)
nro_cnv	0	inteiro	Não	Número CNV do motorista
validade_cnv	0	datetime (01/06/2015 00:00:00)	Não	Validade CNV
nome_pai	0	string(100)	Não	Nome do Pai
nome_mae	0	string(100)	Não	Nome da Mãe
estado_civil	0	string(1)	Não	C: CASADO S: SOLTEIRO D: DIVORCIADO V: VIUVO
moto_registro_cnh	0	string(12)	Não	Número de registro da CNH
moto_orgao_emissor_cnh	0	string(10)	Não	Órgão emissor da CNH da CNH
moto_data_primeira_habilitacao	0	datetime (01/06/2015 00:00:00)	Não	Data da primeira habilitação
moto_data_emissao	0	datetime (01/06/2015 00:00:00)	Não	Data de Emissão da CNH
data_nasc	0	datetime (01/06/2015 00:00:00)	Não	Data Nascimento
data_admissao	0	datetime (01/06/2015 00:00:00)	No	Data de Admissão
rg_emissor	0	string(10)	Não	Órgão Emissor do RG
rg_uf	0	string(2)	Não	Sigla estado emissor RG
naturalidade_descricao_ibge	0	string(100)	Não	Cidade de Naturalidade ou código do IBGE (conforme tabela padrão do IBGE)
naturalidade_uf_sigla	0	string(2)	Não	Sigla estado naturalidade
cnh_seg	0	string(11)	Não	Número segurança CNH
cnh_uf	0	string(2)	Não	Sigla estado emissor CNH
transportador	0	lista (array)	Não	Array de transportadores, podendo associar vários neste array
documento_transportador	1	texto (30)	Não	CPF/CNPJ do transportador
vinculo_contratual	1	inteiro	Não	Tipo de vínculo com o Transportador. 1=Fixo; 2=Agregado; 3=Terceiro
contatos	0	lista (array)	Não	Contatos do motorista, podendo associar vários neste array
codigo	1	inteiro	Não	Código do contato, para fazer alterações no contato
email	1	string(100)	Não	Email do contato
celular	1	string(30)	Não	Celular do contato
fone1	1	string(30)	Não	Telefone do contato
fone2	1	string(30)	Não	Telefone do contato secundário
texto	1	string(100)	Não	Nome do contato
profissao	0	string(50)	Não	Nome da Profissao

Requisição para envio dos dados de Motorista:

{
    "motorista": [ -- podem ser enviados vários motoristas dentro deste array.
    {
        "cpf_motorista": "69371875569",
        "nome": "WS REST",
        "matricula": "123",
        "empresa_contratante": "001",
        "rg": "20121033950",
        "logradouro": "WS REST",
        "cep": "89817000",
        "numero": "44",
        "complemento": "WS REST",
        "bairro": "WS REST",
        "cidade": "CHAPECO",
        "sigla_estado": "SC",
        "pais": "Brasil",
        "nro_cnh": "A",
        "categoria_cnh": null,
        "validade_cnh": null,
        "senha": null,
        "vigilante": null,
        "nro_cnv": null,
        "validade_cnv": null,
        "transportador": [
            {
                "documento_transportador": "10884397000185",
                "vinculo_contratual": 2
            }
        ]
    }]
}

Retorno em caso de Sucesso:


{
    "sucesso": [
        {
                "cod": "0",
                "codigo_motorista": cod,
                "mensagem": "operacao realizada com sucesso"
        }
    ],
    "success": [
        {
                "cod": "0",
                "codigo_motorista": cod,
                "mensagem": "operacao realizada com sucesso"
        }
    ],
    "error": []
}

EnviarNaoConformidadeMotorista

[POST] http://ip.do.cliente:porta/ws_rest/public/api/naoconformidademotorista

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
doc_cliente_suspensao	0	texto	Sim	CNPJ/CPF da empresa que está gerando a suspensão.
cpf_motorista	0	texto	Sim	CPF do motorista da suspensão.
bloqueado_ate	0	Date/Time	Não	Data/Hora limite para que a suspensão esteja vigente. Não é permitido data retroativa à data de criação da suspensão. Formato DD/MM/YYYY HH:MM
necessita_liberacao	0	texto	Não	Parâmetro para liberação do motorista, aceitando somente 3 valores: “NAO”, “ELEARNING” e “PRESENCIAL”.
doc_transportador	0	texto	Não	CNPJ/CPF do transportador que está enviando a requisição.
motivo_suspensao	0	Array	Não	Array de descrições dos motivos de suspensão listado no ambiente web.
descricao	1	texto	Não	Descrição do motivo da suspenção.
observacao	0	texto (200)	Não	Observação da não conformidade.
motivo_interno	0	texto (200)	Não	Motivo interno da não conformidade.
codigo_modulo_elearning	0	inteiro	Sim	Código do Módulo E-learning (obtido no método GET /moduloelearning). Este campo é obrigatório caso a tag "necessita_liberacao" estiver preenchida como "E-LEARNING".

Requisição para envio dos dados de Não Conformidade Motorista:

{
    "doc_cliente_suspensao": "84.447.999/0001-09",
    "cpf_motorista": "872.590.999-72",
    "bloqueado_ate": "27/02/2024 17:50",
    "necessita_liberacao": "E-LEARNING",
    "doc_transportador": "84.447.999/0001-09",
    "motivo_suspensao": [
        {
            "descricao": "Dossiê Motorist"
        },
        {
            "descricao": "Descumprimento das Regras de Plano de Gerenciamento"
        }
    ],
    "observacao": "teste de observacao",
    "motivo_interno": "teste de motivo interno",
    "codigo_modulo_elearning": "22"
}

Retorno em caso de Sucesso:

{
    "success": {
        "mensagem": "Operação Concluida",
        "status": true
    },
    "error": []
}

EnviarModulosElearning

[POST] http://ip.do.cliente:porta/ws_rest/public/api/moduloselearning

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
nome_modulo	0	texto	Sim	Nome do módulo e-learning.
status	0	texto	Sim	Status do módulo e-learning, aceitando valores "Ativo" ou "Inativo".

Requisição para envio dos dados de Módulo E-Learning:

{
    "nome_modulo": "nome do modulo",
    "status": "ativo"
}

Retorno em caso de Sucesso:

{
    "success": {
        "mensagem": "Operação Concluida",
        "status": true
    },
    "error": []
}

EnviarVeiculo

[POST] http://ip.do.cliente:porta/ws_rest/public/api/veiculo

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
placa	0	texto (10)	Sim	Placa do veículo
tipo_veiculo	0	inteiro	SIM	Tipo de veículo. 1 = Carreta; 2 = Cavalo; 3 = Truck; 4 = Moto; 5 = Utilitário de Carga; 6 = Utilitário de Passeio; 7 = Toco;
frota	0	texto (10)	Não	Frota do veiculo
renavam	0	texto (10)	Não	Renavam do veículo
chassi	0	texto (50)	Não	Chassi do veículo
estacao_gr	0	inteiro	Não	Estação Rastreamento
veic_pgpg_codigo	0	inteiro	Não	Código do PGR
documento_proprietario	0	texto (30)	Não	CNPJ / CPF do proprietario (documento) do veículo
documento_proprietario_posse	0	texto (30)	Não	CNPJ / CPF do proprietario (posse) do veículo
documento_transportador	0	texto (30)	Não	CNPJ / CPF do transportador do veículo
documento_gestor	0	texto (30)	Não	CPF do gestor da frota do veículo
senha_proprietario	0	texto (20)	Não	Senha do proprietário do veículo
senha_coacao	0	texto (20)	Não	Senha de coação do veículo
modelo	0	texto (50)	Não	Modelo do veículo
marca	0	texto (50)	Não	Marca do Veículo
cpf_motorista (depreciado)	0	texto (20)	Não	CPF do motorista do veículo
ano_fabricacao	0	texto (4)	Não	Ano de fabricação do veículo
ano_modelo	0	texto (4)	Não	Ano de modelo do veículo
cor	0	texto (20)	Não	Cor do veículo
tamanho	0	numérico	Não	Tamanho do veículo
cidade_emplacamento	0	texto (100)	Não	Descricao Cidade emplacamento ou código do IBGE (conforme tabela padrão do IBGE)
sigla_estado	0	texto (2)	Não	Sigla UF (estado da cidade)
pais	0	texto (50)	Não	Pais
telefone	0	texto (20)	Não	Telefone do veiculo
antt	0	texto (50)	Não	ANTT do veículo
rntc	0	texto (10)	Não	RNTC do veiculo
crlv	0	inteiro	Não	CRLV do veículo
capacidade_maxima	0	inteiro	Não	Capacidade máxima de carga
unidade_medida	0	Constante	Não	FAR = FARDO LIT = LITRO QUI = KG PAL = PALLET MEC = METRO_CUBICO QUI = QUILOS UVO = UNIDADES_VOLUMES
tipo_unidade_medida	0	Constante	Não	CAX = CAIXAS PAL = PALLETS
tipo_carroceria	0	Constante	Não	1 = AMBULÂNCIA 2 = BASCULANTE 3 = BLINDADA 4 = BUGGY 5 = CAB. FECHADA 6 = C. ABERTA 8 = CONVERSÍVEL 9 = FURGÃO 10 = JIPE 11 = TRAILER 12 = MOTOCICLETAS 13 = SIDER
combustivel	0	Constante	Não	0 = GASOLINA 1 = ETANOL 2 = DIESEL 3 = FLEX
tipo_combustivel	0	texto (3)	Não	GAS = GASOLINA ETA = ETANOL DIE = DIESEL GNV = GÁS NATURAL VEICULAR
data_emissao	0	datetime (01/06/2015 00:00:00)	Não	Data de emissão do documento
observacao_veiculo	0	texto (5000)	Não	Observação do veículo
terminais	0	lista (array)	Não	Terminais da veiculo
numero	1	texto (30)	Não	Número do terminal do Veículo
tecnologia	1	string(50)	Não	Descrição da Tecnologia
cod_versao_tecnologia	1	inteiro	Não	Código da versão da tecnologia. Será dado prioridade para esse campo quando informado, caso contrário será utilizado o campo "tecnologia" para efetuar a busca pelo terminal.
transportadores	0	lista (array)	Não	Transportador
documento_transportador	1	texto (30)	Sim	CPF/CNPJ do transportador
vinculo_contratual	1	inteiro	Sim	Tipo de vínculo com o Transportador. 1=Fixo; 2=Agregado; 3=Terceiro
motoristas	0	lista (array)	Não	Motorista
documento	1	texto (30)	Sim	CPF do motorista
status	0	Constante	Não	1 = ATIVO 2 = INATIVO
tipo_operacao	0	texto (30)	Não	Tipo da Operação
tecn_descricao	0	texto (50)	Não	Tecnologia do Terminal Principal
term_numero_terminal	0	texto (30)	Não	Terminal Principal
tecn_descricao2	0	texto (50)	Não	Tecnologia do Terminal Secundário
term_numero_terminal2	0	texto (30)	Não	Terminal Secundário
quarteirizado	0	boolean	Não	Quarteirizado
alto_desempenho	0	boolean	Não	Veículo de Alto Desempenho
eixos	0	inteiro	Não	Eixos
sigla_base	0	texto (10)	Não	Sigla da base
base_operacional	0	texto (50)	Não	Bases Operacionais
validade_antt	0	data	Não	Validade ANTT (Formato MM/YYYY)
validade_rntrc	0	data	Não	Validade RNTC (Formato MM/YYYY)
tac	0	texto (10)	Não	TAC
validade_tac	0	data	Não	Validade TAC (Formato MM/YYYY)
blindado	0	boolean	Não	Blindado
tara	0	inteiro	Não	Tara
cubagem	0	inteirno	Não	Cubagem
estacao_supervisor	0	inteirno	Não	Estação da supervisão do veículo
lista_observacao	0	lista (array)	Não	Lista de observações da viagem

Requisição para envio dos dados de Veículo:

 {
    "veiculo": [-- podem ser enviados vários veículos dentro deste array.
    {
        "placa": "WS_REST",
        "frota": "WS_REST",
        "renavam": "WS_REST",
        "chassi": "WS_REST",
        "tipo_veiculo": 2,
        "documento_proprietario": "16165647000103",
        "documento_transportador": "29872062000175",
        "senha_proprietario": "1234565",
        "senha_coacao": "WS_REST",
        "modelo": "AGRALE 13000",
        "marca": "AGRALE",
        "cpf_motorista": "026083528-55",
        "ano_fabricacao": "2011",
        "ano_modelo": "1993",
        "cor": "1",
        "tamanho": 0,
        "cidade_emplacamento": "Guatambu",
        "sigla_estado": "SP",
        "pais": "Brasil",
        "telefone": "99999999",
        "antt": 1,
        "rntc": 1,
        "crlv": 1,
        "observacao_veiculo": "motora",
        "estacao_supervisor": 5,
        "terminais": [
            {
                "numero": "1988942",
                "tecnologia": "SASCAR",
                "cod_versao_tecnologia": 1
            },{
                "numero": "TRI0003",
                "tecnologia": "ONIXSAT"
            }
        ],
        "transportadores": [
            {
                "documento_transportador": "29872062000175",
                "vinculo_contratual": 1
            }
        ],
        "motoristas": [
            {
                "documento": "123456789-00"
            }
        ],
        "lista_observacao": [
            "Observação 1",
            "Observação 2"
        ],
    }]
}

Retorno em caso de Sucesso:


{
    "sucesso": [
        {
                "cod": "0",
                "codigo_veiculo": cod,
                "mensagem": "operacao realizada com sucesso"
        }
    ],
    "success": [
        {
                "cod": "0",
                "codigo_veiculo": cod,
                "mensagem": "operacao realizada com sucesso"
        }
    ],
    "error": []
}

EnviarAjudante

[POST] http://ip.do.cliente:porta/ws_rest/public/api/ajudante

O JSON de envio é idêntico ao de retorno do método BuscarAjudante. (Podem ser enviados vários objetos)

Parâmetros a serem enviados

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
cpf_ajudante	1	string(20)	Sim	CPF do ajudante
nome	1	string(50)	Sim	Nome da pessoa
rg	1	string(20)	Não	RG do Ajudante
matricula	1	texto (50)	Não	Matrícula
empresa_contratante	1	texto (20)	Não	Cód. da Empresa Contratante
logradouro	1	string(200)	Não	Descrição do Logradouro
cep	1	string(8)	Não	CEP do Logradouro
numero	1	string(50)	Não	Número do Logradouro
complemento	1	string(100)	Não	Descrição do Bairro do Logradouro
bairro	1	string(100)	Não	Descrição do Bairro do Logradouro
cidade	1	string(100)	Não	Descrição da Cidade ou Código do IBGE da cidade
sigla_estado	1	string(2)	Não	Sigla do Estado do Logradouro
pais	1	string(50)	Não	Pais
nome_pai	1	string(100)	Não	Nome do Pai
nome_mae	1	string(100)	Não	Nome da Mãe
data_nasc	1	datetime (01/06/2015 00:00:00)	Não	Data Nascimento
rg_emissor	1	string(10)	Não	Órgão Emissor do RG
estado_civil	1	string(1)	Não	C: CASADO S: SOLTEIRO D: DIVORCIADO V: VIUVO
rg_uf	1	string(2)	Não	Sigla estado emissor RG
naturalidade_descricao_ibge	1	string(100)	Não	Cidade de Naturalidade ou código do IBGE (conforme tabela padrão do IBGE)
naturalidade_uf_sigla	1	string(2)	Não	Sigla estado naturalidade
contatos	1	lista (array)	Não	Contatos do Ajudante, podendo associar vários neste array
codigo	2	inteiro	Não	Código do contato, para fazer alterações no contato
email	2	string(100)	Não	Email do contato
fone1	2	string(30)	Não	Telefone do contato
texto	2	string(100)	Não	Nome do contato
rg	1	string(20)	Não	RG do Ajudante
matricula	1	texto (50)	Não	Matrcula
empresa_contratante	1	texto (20)	Não	Cd. da Empresa Contratante
logradouro	1	string(200)	Não	Descrio do Logradouro
cep	1	string(8)	Não	CEP do Logradouro
numero	1	string(50)	Não	Nmero do Logradouro
complemento	1	string(100)	Não	Descrio do Bairro do Logradouro
bairro	1	string(100)	Não	Descrio do Bairro do Logradouro
cidade	1	string(100)	Não	Descrio da Cidade ou Cdigo do IBGE da cidade
sigla_estado	1	string(2)	Não	Sigla do Estado do Logradouro
pais	1	string(50)	Não	Pais
nome_pai	1	string(100)	Não	Nome do Pai
nome_mae	1	string(100)	Não	Nome da Me
data_nasc	1	datetime (01/06/2015 00:00:00)	Não	Data Nascimento
rg_emissor	1	string(10)	Não	Órgão Emissor do RG
estado_civil	1	string(1)	Não	C: CASADO S: SOLTEIRO D: DIVORCIADO V: VIUVO
rg_uf	1	string(2)	Não	Sigla estado emissor RG
naturalidade_descricao_ibge	1	string(100)	Não	Cidade de Naturalidade ou cdigo do IBGE (conforme tabela padro do IBGE)
naturalidade_uf_sigla	1	string(2)	Não	Sigla estado naturalidade
profissao	1	string(50)	Não	Nome da Profissao
transportador	1	lista (array)	Não	Array de transportadores, podendo associar vários neste array
documento_transportador	2	texto (30)	Não	CPF/CNPJ do transportador

Retorno Sucesso



{
    "sucesso": [
        {
                "cod": "0",
                "codigo_embarcador": cod,
                "mensagem": "operacao realizada com sucesso"
        }
    ],
    "success": [
        {
                "cod": "0",
                "codigo_embarcador": cod,
                "mensagem": "operacao realizada com sucesso"
        }
    ],
    "error": []
}

Retorno Erro

    {
    "sucesso": [],
        "success": [],
    "error": [
        {
            "cod": "1",
            "valor": "cnpj",
            "campo": "cnpj_embarcador",
            "mensagem": "necessario informar um cpf"
        }{
            "cod": "2",
            "valor": "cnpj",
            "campo": "cnpj_embarcador",
            "mensagem": "cnpj ja existente"
        }{
            "cod": "4",
            "valor": "",
            "campo": "cidade",
            "mensagem": "cidade nao encontrada"
        }{
            "cod": "5",
            "valor": "",
            "campo": "logradouro, cep",
            "mensagem": "logradouro ou cep obrigatorio se informado cidade, estado, pais ou bairro"
        }{
            "cod": "6",
            "valor": "",
            "campo": "sigla_estado",
            "mensagem": "estado nao encontrado"
        }{
            "cod": "6",
            "valor": "",
            "campo": "pais",
            "mensagem": "pais nao encontrado"
        }{
            "cod": "7",
            "valor": "",
            "campo": "pgr_padrao",
            "mensagem": "pgr não encontrado"
        }{
            "cod": "8",
            "valor": "",
            "campo": "cnpj_embarcador",
            "mensagem": "cnpj ja cadastrado"
        }{
            "cod": "9",
            "valor": "",
            "campo": "estacao_gr_padrao",
            "mensagem": "estacao gr nao encontrado"
        }{
            "cod": "10",
            "valor": "",
            "campo": "nome",
            "mensagem": "necessario informar um nome"
        }{
            "cod": "11",
            "valor": "",
            "campo": "cnpj_embarcador",
            "mensagem": "cnpj invalido"
        }{
            "cod": "12",
            "valor": "",
            "campo": "null",
            "mensagem": "Erro ao cadastrar embarcador"
        }
    ]
}

EnviarEventos

[POST] http://ip.do.cliente:porta/ws_rest/public/api/eventos

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
eventos	0	Array	Sim	Tag principal json
tipo_evento	1	inteiro	Sim	Código fixo conforme a tabela de tipos de eventos que podem ser gerados
descricao	1	texto (100)	Sim	Descrição do evento gerado
placa	1	texto (10)	Sim	Placa do veículo
numero_terminal	1	texto (30)	Sim	Número do terminal do veiculo
tecnologia	1	texto (50)	Sim	Descricao tecnologia do terminal
data_bordo	1	datetime (2018-10-02 11:34:29)	Sim	Data de bordo do evento
posicao	1	texto (200)	Sim	Descricao da posição do local do evento
latitude	1	texto (15)	Sim	Latitude local do evento
longitude	1	texto (15)	Sim	Longitude do local do evento
codigo_viagem	1	inteiro	Não	Código da viagem

Requisição para envio dos dados de Eventos

 {
    "eventos": [
         {
            "tipo_evento": 113,
            "descricao": "INICIO DE PERNOITE.",
            "placa": "ONX0001",
            "numero_terminal": "ONX0001",
            "tecnologia": "ONIXSAT",
            "data_bordo": "2018-10-02 11:34:29",
            "posicao": "0.600 KM DE PT. EXPRESSO CHAPECO -CHAPECO/SC",
            "latitude": "-27.1125032348",
            "longitude": "-52.5643014908",
            "codigo_viagem": 9511
        }
    ]
}

Retorno em caso de Sucesso:



{
    "sucesso": [
       {
                "cod": "0",
                "valor": 43344,
                "mensagem": "operacao realizada com sucesso"
            }
    ],
    "success": [
       {
                "cod": "0",
                "valor": 43344,
                "mensagem": "operacao realizada com sucesso"
            }
    ],
    "error": []
}

EnviarEventosGreenMile

[POST] http://ip.do.cliente:porta/ws_rest/public/api/eventos/greenmile

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
	0	Array	Sim	Array principal do json
identificador	1	texto (100)	Sim	Identificador do de-para dos veículos cadastrados no assistente de associação de placas Green Mile
tipo_evento	1	texto (10)	Sim	Código do evento que será gerado
data_evento	1	texto (50)	Sim	Data do evento, necessário que string inicie no formato DD/MM/YYYY HH:MM
latitude	1	texto (19)	Sim	Latitude da localização
longitude	1	texto (19)	Sim	Longitude da localização

Requisição para envio dos dados de Eventos Green Mile

[
    {
        "identificador": "2042244",
        "tipo_evento": "544",
        "data_evento": "04/01/2025 08:00",
        "latitude": "-14.28830337524",
        "longitude": "-87.3068771362"
    },
    {
        "identificador": "2042245",
        "tipo_evento": "543",
        "data_evento": "01/01/2025 08:00 (America/Sao Paulo)",
        "latitude": "-30.043299",
        "longitude": "-51.1674007"
    }
]

Retorno em caso de Sucesso:

{
    "statusCode": "1",
    "status": "sucesso",
    "sucessos": [
        {
        "valor": 119267874,
        "mensagem": "operacao realizada com sucesso"
        }
    ],
    "erros": []
}

Retorno em caso de Sucesso, com exceções:

{
    "statusCode": "2",
    "status": "sucesso, com exceções",
    "sucessos": [
        {
        "valor": 119267873,
        "mensagem": "operacao realizada com sucesso"
        }
    ],
    "erros": [
        {
        "campo": "data_evento",
        "valor": "44/01/2025 08:00",
        "mensagem": "Data do evento inválida."
        }
    ]
}

Retorno em caso de Erro:

{
    "statusCode": "0",
    "status": "erro",
    "sucessos": [],
    "erros": [
        {
        "campo": "data_evento",
        "valor": "44/01/2025 08:00",
        "mensagem": "Data do evento inválida."
        },
        {
        "campo": "identificador",
        "valor": "2042245",
        "mensagem": "Identificador não encontrado."
        }
    ]
}

EnviarRota

[POST] http://ip.do.cliente:porta/ws_rest/public/api/rota

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
rotas	0	Array	Sim	Tag principal json
descricao	1	texto (500)	Sim	Descrição da Rota
identificador	1	texto (20)	Não	Identificador da Rota
documento_dono	1	texto (20)	Não	Número do documento do dono da rota
distancia	1	Real	Não	Distância da Rota (Obrigatório quando for informado Coordenadas)
coordenadas	1	texto	Não	Polyline criptografada da Rota no formato GoogleMaps
pontos_rota	2	Array	Sim	Pontos da Rota
descricao_local	2	texto (200)	Sim	Descrição do local
tipo_local	2	inteiro	Sim	Tipo de Parada (disponíveis em Parâmetros Tipo de Parada)
latitude	2	texto (15)	Não	Latitude do local
longitude	2	texto (15)	Não	Longitude do local
logradouro	2	texto (200)	Não	Logradouro do Local
complemento	2	texto (100)	Não	Complemento do Logradouro
cep	2	texto (8)	Não	CEP do Logradouro do Local
numero	2	texto (50)	Não	Número do Local
bairro	2	texto (100)	Não	Bairro do Local
cidade_descricao_ibge	2	texto (100)	Não	Descrição da Cidade ou Código IBGE
sigla_estado	2	texto (2)	Não	Sigla do Estado do Logradouro
pais	2	texto (50)	Não	Pais
raio	2	real	Não	Raio do local
velocidade_media	1	inteiro	Não	Média de Velocidade
tempo_total_parado	1	inteiro	Não	Tempo Total Parado (min)
tempo_tolerancia_atraso	1	inteiro	Não	Tempo Tolerância Atraso (min)
valores_frete	1	Array	Não	Valores de frete para a rota.
tipo_veiculo	2	inteiro	Sim	Tipo de veiculo.
tipo_carroceria	2	inteiro	Sim	Tipo de carroceria.
valor_frete_fechado	2	float	Não	Valor do frete fechado.
valor_frete	2	float	Não	Valor do frete.
valor_pedagio	2	float	Não	Valor do pedágio.
valor_ajudante	2	float	Não	Valor do ajudante.
valor_motorista_adicional	2	float	Não	Valor do motorista adicional.
valor_fiscais_adicionais	2	float	Não	Valor fiscal.
valor_km_adicionais	2	float	Não	Valor do KM adicional.
Necessário informar Latitude e Longitude, caso contrário informar todos os demais dados para o detalhamento do logradouro.

Requisição para envio dos dados de Rotas

{
    "rotas": [
        {
            "descricao": "43285- ",
            "documento_dono": "43919968000129",
            "identificador": "CLP_pcp_TZX_10303",
            "pontos_rota": [
                {
                    "descricao_local": "ORIGEM CARGA",
                    "tipo_local": 4,
                    "latitude": "-27.1125032348",
                    "longitude": "-52.5643014908",
                            "logradouro": "",
                            "complemento": "",
                            "cep": "0095008",
                            "numero": "",
                            "bairro": "TREVO",
                            "cidade_descricao_ibge": "Guatambu",
                            "sigla_estado": "SC",
                            "pais": "BRASIL",
                            "raio": "500"
                },
                {
                    "descricao_local": "TRANSPORTADORA DA COLETA",
                    "tipo_local": 3,
                    "latitude": "",
                    "longitude": "",
                            "logradouro": "AVENIDA GENERAL CARLOS CAVALCANTI",
                            "complemento": "CASA",
                            "cep": "0095008",
                            "numero": "510",
                            "bairro": "CENTRO",
                            "cidade_descricao_ibge": "PONTA GROSSA",
                            "sigla_estado": "PR",
                            "pais": "BRASIL",
                            "raio": "500"
                },
                {
                    "descricao_local": "DESTINO DESCARGA",
                    "tipo_local": 5,
                    "latitude": "-21.5900000000",
                    "longitude": "-42.5005555556",
                            "logradouro": "",
                            "complemento": "",
                            "cep": "",
                            "numero": "",
                            "bairro": "TREVO",
                            "cidade_descricao_ibge": "Guatambu",
                            "sigla_estado": "SC",
                            "pais": "BRASIL",
                            "raio": "500"
                }
            ],
            "velocidade_media": 55,
            "tempo_total_parado": 0,
            "tempo_tolerancia_atraso": 10,
            "valores_frete": [
                {
                    "tipo_veiculo": 2,
                    "tipo_carroceria": 1,
                    "valor_frete_fechado": 250.5,
                    "valor_frete": 250.5,
                    "valor_pedagio": 20,
                    "valor_ajudante": 30,
                    "valor_motorista_adicional": 45.2,
                    "valor_fiscais_adicionais ": 52.5,
                    "valor_km_adicionais": 25
                }
            ]
        }
    ]
}

Retorno em caso de Sucesso:



{
    "sucesso": [
       {
                "cod": "0",
                "valor": 43344,
                "mensagem": "operacao realizada com sucesso"
            }
    ],
    "success": [
       {
                "cod": "0",
                "valor": 43344,
                "mensagem": "operacao realizada com sucesso"
            }
    ],
    "error": []
}

EnviarPGR

[POST] http://ip.do.cliente:porta/ws_rest/public/api/pgr

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
pgr	0	Array	Sim	Tag principal json
descricao	1	texto (100)	Sim	Descrição do PGR
pgr_padrao	1	Inteiro	Não	PGR padrão a ser utilizado como modelo para que as configurações de detalhes e ações sejam clonadas
valor_minimo	1	Real	Não	Valor Mínimo do PGR
valor_maximo_especifico	1	Real	Não	Valor máximo específico do PGR
valor_total	1	Real	Não	Valor máximo Total do PGR
grau_risco	1	Inteiro	Não	1 = Muito Alto; 2 = Alto; 3 = Médio; 4 = Baixo; 5 = Irrelevante
versoes	2	Array	Não	Versões tecnologia
codigo_versao_tecnologia	2	inteiro	Não	Versão de tecnologia de acordo com método BuscarVersoesTecnologia
sublimites	2	Array	Não	Sublimite de produtos
tipo_produto	2	texto (50)	Não	Descrição do tipo de produto
valor_maximo	2	Real	Não	Valor máximo deste tipo de produto

Requisição para envio dos dados de Eventos

 {
    "pgr": [
        {
            "pgr_padrao": 804,
            "descricao": "INICIO DE VIAGEM SEM AGENDAMENTO",
            "grau_risco": "1",
            "valor_minimo": "5441.00",
            "valor_maximo_especifico": "2336.00",
            "valor_total": "7777.00",
            "versoes": [{
                "codigo_versao_tecnologia":"12"
            }],
            "sublimites": [{
                "tipo_produto":"CELULOSE",
                "valor_maximo": "012.00"

            }]
        }]
}

Retorno em caso de Sucesso:



{
    "sucesso": [
       {
                "cod": "0",
                "valor": 43344,
                "mensagem": "operacao realizada com sucesso"
            }
    ],
    "success": [
       {
                "cod": "0",
                "valor": 43344,
                "mensagem": "operacao realizada com sucesso"
            }
    ],
    "error": []
}

EnviarPesquisa (Método depreciado)

~~[POST] http://ip.do.cliente:porta/ws_rest/public/api/historico-pesquisa~~

~~Parâmetros a serem enviados:~~

~~Envio de Autenticação no cabeçalho HTTP / HTTPS.~~

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
TipoObjeto	1	texto (2)	Sim	Tipo de Objeto de Pesquisa (disponível na documentação no Tipo de Objeto de Pesquisa)
Documento	1	texto (50)	Sim	Documento do Transportador proprietário da pesquisa
Objeto	1	texto (50)	Sim	Objeto da pesquisa (Placa/CPF/CNPJ)
Status	1	texto (2)	Sim	Status da pesquisa (disponível na documentação no Status de Pesquisa)
TipoValidade	1	texto (2)	Sim	Tipo de validade da pesquisa por data ou viagem, constantes "DT" ou "VI"
ContaTecnologia	1	Inteiro	Sim	Conta de Tecnologia (lista disponível a partir do método BuscarContaTecnologia)
NumeroLiberacao	1	texto (50)	Não	Descrição do Número da pesquisa
DataValidade	1	datetime (2018-10-02 11:34:29)	Não	Data de validade da pesquisa

~~Requisição para envio dos dados da Pesquisa~~

                    {
                    "pesquisas":[
                        {
                            "TipoObjeto": "TR",
                            "Documento": "23412744000119",
                            "Objeto": "23412744000119",
                            "ContaTecnologia": "5000",
                            "Status": "IN",
                            "NumeroLiberacao":"321333",
                            "DataValidade":"2018-10-02 11:34:29"
                        }
                        ]
                    }

Observação: Caso o transportador e o objeto não possuirem vinculo, será feito um vinculo automaticamente ao sucesso da requisição. Isso se aplica aos tipos "MO", "VC", "VM" e "AJ"

EnviarArea

[POST] http://ip.do.cliente:porta/ws_rest/public/api/area

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
areas	0	Array	Sim	Tag principal json
area_descricao	1	texto (200)	Sim	Descrição da área a ser cadastrada.
classe_referencia	1	texto (50)	Sim	Descrição classe de referência a ser vinculada na área.
area_pontos	1	Array	Sim	Lista dos pontos geográficos. Mínimo 3 pontos.
latitude	2	texto	Sim	Latitude do ponto.
longitude	2	texto	Sim	Longitude do ponto.

Requisição para envio dos dados de Area

{
    "areas": [
        {
            "area_descricao": "Ponto de Parada",
            "classe_referencia": "Referencias gerais",
            "area_pontos": [
                {
                    "latitude": -9.74128212247572700,
                    "longitude": -61.63496334185140000
                },
                {
                    "latitude": -7.74128212247572700,
                    "longitude": -62.63496334185140000
                },
                {
                    "latitude": -6.74128212247572700,
                    "longitude": -63.63496334185140000
                }
            ]
        },
        {
            "area_descricao": "Ponto de coleta",
            "classe_referencia": "Hospitais",
            "area_pontos": [
                {
                    "latitude": -8.74128212247572700,
                    "longitude": -61.63496334185140000
                },
                {
                    "latitude": -8.74128212247572700,
                    "longitude": -62.63496334185140000
                },
                {
                    "latitude": -8.74128212247572700,
                    "longitude": -63.63496334185140000
                }
            ]
        }
    ]
}

Retorno em caso de Sucesso:



{
    "sucesso": [
        [
            {
                "cod": 1,
                "codigo_area": 651,
                "mensagem": "operacao realizada com sucesso"
            },
            {
                "cod": 1,
                "codigo_area": 652,
                "mensagem": "operacao realizada com sucesso"
            }
        ]
    ],
    "success": [
        [
            {
                "cod": 1,
                "codigo_area": 651,
                "mensagem": "operacao realizada com sucesso"
            },
            {
                "cod": 1,
                "codigo_area": 652,
                "mensagem": "operacao realizada com sucesso"
            }
        ]
    ],
    "error": ""
}

DuplicarPGR

[POST] http://ip.do.cliente:porta/ws_rest/public/api/planogr/duplicar

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Tipo	Obrigatório	Descrição
pgr	Int	Sim	Tag principal json
descricao	texto (100)	NÃO	Descrição do PGR

Requisição para envio dos dados de PGR:

                    {
                        "pgr": 1234,
                        "descricao": "Exemplo duplicar"
                    }

Retorno em caso de Sucesso:

                    {
                        "success": {
                            "codigo": 4348,
                            "status": "ok"
                        },
                        "error": []
                    }

AtualizarViagem

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/viagem/IdViagem

Possui os mesmos parâmetros do método EnviarViagem. Porém deve ser enviado o código "IdViagem" que será alterado.

Não é permitido alterar mais do que um registro de uma vez, portanto essa informação não deve ser enviado dentro de um array.

Não é permitido alterar viagens finalizadas, caso a viagem esteja iniciada somente será alterado a Rota ou Locais e o PGR da viagem, caso a viagem esteja em agendamento será possível alterar todos campos da viagem.

AtualizarStatusViagem

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/viagem/IdViagem

Requisição para alteração de status de SM / Viagem:

 {
    "status_viagem": {
        "id_novo_status": 1
    }
}

Os status permitidos para alteração da viagem são: 1 = Efetivada; 2 = Cancelada; 5 = Finalizada (quaisquer outros códigos serão rejeitados pelo webservice).

Não é permitido alterar mais do que um registro de uma vez, portanto essa informação não deve ser enviado dentro de um array.

AtualizarNotaFiscal

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/viagemnotafiscal/IdNotaFiscal

Requisição para baixa da nota fiscal:

 {
    "data_baixa": "10/05/2019 12:09:58"
 }

O formato de data deve ser igual ao do exemplo acima (quaisquer outros formatos serão rejeitados pelo webservice).

Não é permitido alterar mais do que um registro de uma vez, portanto essa informação não deve ser enviado dentro de um array.

AtualizarTransportador

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/transportador/IdTransportador

Possui os mesmos parâmetros do método EnviarTransportador. Porém deve ser enviado o código "IdTransportador" que será alterado.

Não é permitido alterar mais do que um registro de uma vez, portanto essa informação não deve ser enviado dentro de um array.

AtualizarEmbarcador

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/embarcador/IdEmbarcador

Possui os mesmos parâmetros do método EnviarEmbarcador. Porém deve ser enviado o código "IdEmbarcador" que será alterado.

Não é permitido alterar mais do que um registro de uma vez, portanto essa informação não deve ser enviado dentro de um array.

AtualizarMotorista

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/motorista/IdMotorista

Possui os mesmos parâmetros do método EnviarMotorista. Porém deve ser enviado o código "IdMotorista" que será alterado.

Não é permitido alterar mais do que um registro de uma vez, portanto essa informação não deve ser enviado dentro de um array.

AtualizarNaoConformidadeMotorista

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/naoconformidademotorista/IdNaoConformidadeMotorista

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
doc_cliente_suspensao	0	texto	Sim	CNPJ/CPF da empresa que está gerando a suspensão.
cpf_motorista	0	texto	Sim	CPF do motorista da suspensão.
situacao	0	texto	Não	Situação da não conformidade, sendo: “BLOQUEADO”, “LIBERADO”, “LIBERADO PARA UMA SM”.
bloqueado_ate	0	Date/Time	Não	Data/Hora limite para que a suspensão esteja vigente. Não é permitido data retroativa à data de criação da suspensão. Formato DD/MM/YYYY HH:MM
necessita_liberacao	0	texto	Não	Parâmetro para liberação do motorista, aceitando somente 3 valores: “NAO”, “ELEARNING” e “PRESENCIAL”.
doc_transportador	0	texto	Não	CNPJ/CPF do transportador que está enviando a requisição.
motivo_suspensao	0	Array	Não	Array de descrições dos motivos de suspensão listado no ambiente web.
descricao	1	texto	Não	Descrição do motivo da suspenção.
observacao	0	texto (200)	Não	Observação da não conformidade.
motivo_interno	0	texto (200)	Não	Motivo interno da não conformidade.
codigo_modulo_elearning	0	inteiro	Sim	Código do Módulo E-learning (obtido no método GET /moduloelearning). Este campo é obrigatório caso a tag "necessita_liberacao" estiver preenchida como "E-LEARNING".

Requisição para atualizar dados de Não Conformidade Motorista:

{
    "doc_cliente_suspensao": "84.447.999/0001-09",
    "cpf_motorista": "872.590.999-72",
    "situacao": "BLOQUEADO",
    "bloqueado_ate": "27/02/2024 17:50",
    "necessita_liberacao": "E-LEARNING",
    "doc_transportador": "84.447.999/0001-09",
    "motivo_suspensao": [
        {
            "descricao": "Dossiê Motorist"
        },
        {
            "descricao": "Descumprimento das Regras de Plano de Gerenciamento"
        }
    ],
    "observacao": "teste de observacao",
    "motivo_interno": "teste de motivo interno",
    "codigo_modulo_elearning": "22"
}

Retorno em caso de Sucesso:

{
    "success": {
        "mensagem": "Operação Concluida",
        "status": true
    },
    "error": []
}

AtualizarModulosElearning

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/moduloselearning/IdModuloElearning

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
nome_modulo	0	texto	Sim	Nome do módulo e-learning.
status	0	texto	Sim	Status do módulo e-learning, aceitando valores "Ativo" ou "Inativo".

Requisição para atualizar dados de Módulo E-Learning:

{
    "nome_modulo": "nome do modulo",
    "status": "ativo"
}

Retorno em caso de Sucesso:

{
    "success": {
        "mensagem": "Operação Concluida",
        "status": true
    },
    "error": []
}

AtualizarAjudante

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/ajudante/IdAjudante

Possui os mesmos parâmetros do método EnviarAjudante. Porém deve ser enviado o código "IdAjudante" que será alterado.

Não é permitido alterar mais do que um registro de uma vez, portanto essa informação não deve ser enviado dentro de um array.

AtualizarVeiculo

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/veiculo/Placa

Possui os mesmos parâmetros do método EnviarVeiculo. Porém deve ser enviado a placa "Placa" que será alterado.

Não é permitido alterar mais do que um registro de uma vez, portanto essa informação não deve ser enviado dentro de um array.

EditarTerminais

[POST] http://ip.do.cliente:porta/ws_rest/public/api/terminais

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
Array de objetos	0	Array	Sim	Array de objetos de terminais
terminal	1	Objeto	Sim	Objeto terminal
codigo	2	int4	Sim*	Código do terminal na base Trafegus; Obrigatório se os campos "numero" e "codigo_versao" não forem informados
numero	2	varchar(30)	Sim*	Número do terminal na base Trafegus; Obrigatório se o campo "codigo" não for informado
codigo_versao	2	int4	Sim*	Código da versão da tecnologia na base Trafegus; Obrigatório se o campo "codigo" não for informado
ativo	2	varchar(1)	Sim	Informação de ativo/inativo a ser atualizada no terminal. Aceita "S" ou "N" sem considerar maiúscula ou minúscula

Requisição para ativação/inativação dos terminais:

[
    {
        "terminal": {
            "codigo": 123,
            "numero": null,
            "codigo_versao": null,
            "ativo": "S"
        }
    },
    {
        "terminal": {
            "codigo": null,
            "numero": "1234",
            "codigo_versao": 123,
            "ativo": "N"
        }
    },
    {
        "terminal": {
            "codigo": null,
            "numero": "KAD7777",
            "codigo_versao": 36,
            "ativo": "S"
        }
    },
    {
        "terminal": {
            "codigo": 138895,
            "numero": null,
            "codigo_versao": null,
            "ativo": "N"
        }
    }
]

Retorno em caso de Sucesso:

[
    {
        "sucesso": [
        {
            "terminal": 138895,
            "status": "true",
            "mensagem": "Terminal atualizado com sucesso."
        }
        ]
    },
    {
        "erro": []
    }
]

Retorno em caso de Erro:

[
    {
        "sucesso": []
    },
    {
        "erro": {
            "codigo": -1,
            "mensagens": [
                {
                "terminal": 1388952,
                "status": "false",
                "mensagem": "Terminal não encontrado."
                }
            ]
        }
    }
]

Retorno em caso de Sucesso/Erro:

[
    {
        "sucesso": [
        {
            "terminal": 100524,
            "status": "true",
            "mensagem": "Terminal atualizado com sucesso."
        },
        {
            "terminal": 138895,
            "status": "true",
            "mensagem": "Terminal atualizado com sucesso."
        }
        ]
    },
    {
        "erro": {
        "codigo": -1,
        "mensagens": [
            {
            "terminal": 123,
            "status": "false",
            "mensagem": "Campo ativo não informado. Preencha com S ou N."
            },
            {
            "status": "false",
            "mensagem": "Informe o codigo ou numero e codigo_versao do terminal."
            }
        ]
        }
    }
]

AtualizarNFAvulsa

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/notafiscal/IdNotaFiscal

Possui os mesmos parâmetros do método EnviarNFAvulsa. Porém deve ser enviado o código "IdNotaFiscal" que será alterado.

Requisição para alteração de uma nota fiscal avulsa:

 {
    "numero": "1234",
    "valor": "555"
}

Não é permitido alterar mais do que um registro de uma vez, portanto essa informação não deve ser enviado dentro de um array.

LerEvento

[POST] http://ip.do.cliente:porta/ws_rest/public/api/lerevento/id_evento

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
idUsuario	0	Inteiro	Sim	Id do usuario que vai ler os eventos
TipoTratamento	0	Inteiro	Sim	Tipo do Tratamento - 0=Operador, 1=Supervisor, 2=Ambos
Descricao	0	texto (100)	Sim	Descrição da Tratativa

Requisição para envio dos dados de Eventos

 {
	"idUsuario": 12,
	"TipoTratamento": 2,
	"Descricao": "Tratando eventos"
}

Retorno em caso de Sucesso:

                {
                    "sucesso": {
                        "cod_status": "0",
                        "esis_codigo": "132179",
                        "mensagem": "sucesso"
                    },
                    "avisos": [],
                    "error": []
                }

Retorno em caso de Erro:



                {
                    "sucesso": [],
                    "avisos": [],
                    "error": {
                        "cod_status": "2",
                        "esis_codigo": "132151",
                        "mensagem": "Usuário não encontrado"
                    },
                    "message": "Page not found."
                }

                {
                    "sucesso": [],
                    "avisos": [],
                    "error": {
                        "cod_status": "1",
                        "esis_codigo": "234",
                        "mensagem": "Evento não encontrado"
                    },
                    "message": "Page not found."
                }

                {
                    "sucesso": {
                        "cod_status": "1",
                        "esis_codigo": "132151",
                        "mensagem": "Evento já esta tratado"
                    },
                    "avisos": [],
                    "error": []
                }

                {
                    "sucesso": [],
                    "avisos": [],
                    "error": {
                        "cod_status": "4",
                        "esis_codigo": "132151",
                        "mensagem": {
                            "idUsuario": {
                                "isEmpty": "O valor é obrigatório e não pode estar vazio"
                            },
                            "TipoTratamento": {
                                "isEmpty": "O valor é obrigatório e não pode estar vazio"
                            },
                            "Descricao": {
                                "isEmpty": "O valor é obrigatório e não pode estar vazio"
                            }
                        }
                    }
                }

AtualizarRota

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/rota/{id_da_rota}

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.
Os campos designados como obrigatórios serão validados somente se forem fornecidos.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
rotas	0	Objeto	Sim	Tag principal json
descricao	1	texto (500)	Sim	Descrição da Rota
identificador	1	texto (20)	Não	Identificador da Rota
documento_dono	1	texto (20)	Não	Número do documento do dono da rota
distancia	1	Real	Não	Distância da Rota (Obrigatório quando for informado Coordenadas)
coordenadas	1	texto	Não	Polyline criptografada da Rota no formato GoogleMaps
pontos_rota	2	Array	Sim	Pontos da Rota
descricao_local	2	texto (200)	Sim	Descrição do local
tipo_local	2	inteiro	Sim	Tipo de Parada (disponíveis em Parâmetros Tipo de Parada)
latitude	2	texto (15)	Não	Latitude do local
longitude	2	texto (15)	Não	Longitude do local
logradouro	2	texto (200)	Não	Logradouro do Local
complemento	2	texto (100)	Não	Complemento do Logradouro
cep	2	texto (8)	Não	CEP do Logradouro do Local
numero	2	texto (50)	Não	Número do Local
bairro	2	texto (100)	Não	Bairro do Local
cidade_descricao_ibge	2	texto (100)	Não	Descrição da Cidade ou Código IBGE
sigla_estado	2	texto (2)	Não	Sigla do Estado do Logradouro
pais	2	texto (50)	Não	Pais
raio	2	real	Não	Raio do local
velocidade_media	1	inteiro	Não	Média de Velocidade
tempo_total_parado	1	inteiro	Não	Tempo Total Parado (min)
tempo_tolerancia_atraso	1	inteiro	Não	Tempo Tolerância Atraso (min)
valores_frete	1	Array	Não	Valores de frete para a rota.
tipo_veiculo	2	inteiro	Sim	Tipo de veiculo.
tipo_carroceria	2	inteiro	Sim	Tipo de carroceria.
valor_frete_fechado	2	float	Não	Valor do frete fechado.
valor_frete	2	float	Não	Valor do frete.
valor_pedagio	2	float	Não	Valor do pedágio.
valor_ajudante	2	float	Não	Valor do ajudante.
valor_motorista_adicional	2	float	Não	Valor do motorista adicional.
valor_fiscais_adicionais	2	float	Não	Valor fiscal.
valor_km_adicionais	2	float	Não	Valor do KM adicional.
Necessário informar Latitude e Longitude, caso contrário informar todos os demais dados para o detalhamento do logradouro.

Requisição para envio dos dados de Rotas

{
    "rotas":
        {
            "descricao": "43285- ",
            "documento_dono": "43919968000129",
            "identificador": "CLP_pcp_TZX_10303",
            "pontos_rota": [
                {
                    "descricao_local": "ORIGEM CARGA",
                    "tipo_local": 4,
                    "latitude": "-27.1125032348",
                    "longitude": "-52.5643014908",
                            "logradouro": "",
                            "complemento": "",
                            "cep": "0095008",
                            "numero": "",
                            "bairro": "TREVO",
                            "cidade_descricao_ibge": "Guatambu",
                            "sigla_estado": "SC",
                            "pais": "BRASIL",
                            "raio": "500"
                },
                {
                    "descricao_local": "TRANSPORTADORA DA COLETA",
                    "tipo_local": 3,
                    "latitude": "",
                    "longitude": "",
                            "logradouro": "AVENIDA GENERAL CARLOS CAVALCANTI",
                            "complemento": "CASA",
                            "cep": "0095008",
                            "numero": "510",
                            "bairro": "CENTRO",
                            "cidade_descricao_ibge": "PONTA GROSSA",
                            "sigla_estado": "PR",
                            "pais": "BRASIL",
                            "raio": "500"
                },
                {
                    "descricao_local": "DESTINO DESCARGA",
                    "tipo_local": 5,
                    "latitude": "-21.5900000000",
                    "longitude": "-42.5005555556",
                            "logradouro": "",
                            "complemento": "",
                            "cep": "",
                            "numero": "",
                            "bairro": "TREVO",
                            "cidade_descricao_ibge": "Guatambu",
                            "sigla_estado": "SC",
                            "pais": "BRASIL",
                            "raio": "500"
                }
            ],
            "velocidade_media": 55,
            "tempo_total_parado": 0,
            "tempo_tolerancia_atraso": 10,
            "valores_frete": [
                {
                    "tipo_veiculo": 2,
                    "tipo_carroceria": 1,
                    "valor_frete_fechado": 250.5,
                    "valor_frete": 250.5,
                    "valor_pedagio": 20,
                    "valor_ajudante": 30,
                    "valor_motorista_adicional": 45.2,
                    "valor_fiscais_adicionais ": 52.5,
                    "valor_km_adicionais": 25
                }
            ]
        }
}

Retorno em caso de Sucesso:



{
    "sucesso": [
       {
                "cod": "0",
                "valor": 43344,
                "mensagem": "operacao realizada com sucesso"
            }
    ],
    "success": [
       {
                "cod": "0",
                "valor": 43344,
                "mensagem": "operacao realizada com sucesso"
            }
    ],
    "error": []
}

AtualizarViagemSentinel

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/viagem/sentinel

Possui os mesmos parâmetros do método EnviarViagemPosicaoSentinel. Deve ser enviado o código "shipmentId" para localizar a SM que será alterada.

Os retornos desse método são os mesmos do EnviarViagemPosicaoSentinel.

AtualizarViagemVuupt

[PUT] http://ip.do.cliente:porta/ws_rest/public/api/viagem/vuupt

Possui os mesmos parâmetros do método EnviarViagemPosicaoVuupt. Deve ser enviado o código "payload:id" para localizar a SM que será alterada.

Os retornos desse método são os mesmos do EnviarViagemPosicaoVuupt.

BuscarPosicaoVeiculo

Retorna informações de Posições(es)

Para consultar as posições de um veículo em específico deve ser infromado na URL os seguintes parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
IdPosicao:	inteiro	Sim	Id (código) da última posição recebida (para buscar as posteriores a este código).
Documento:	texto	Não	Documento (CNPJ/CPF) da transportadora do veículo.
Documento:	lista(array)	Não	Documento (CNPJ/CPF) das transportadoras dos veículos. Limite de 10 transportadoras.
DocumentosProp	lista(array)	Não	Documento (CNPJ/CPF) dos Proprietários dos veículos. Limite de 10 Proprietários.
Placa:	texto	Não	Placa do veículo.
Placas:	lista(array)	Não	Placas do veículos. Limite de 30 placas.
Qtde:	inteiro	Não	Quantidade de registro a ser recebida (máximo 1000, caso não informado máximo por padrão é 1000).
CodViag:	inteiro	Não	Código da viagem.
DataCadastroI:	data	Não	Data de Início (formato DD/MM/YYYY) para filtro de período de cadastro.
DataCadastroF:	data	Não	Data de Fim (formato DD/MM/YYYY) para filtro de período de cadastro.
SomenteUltimaPosicao:	inteiro	Não	Buscar somente última posição do(s) veículo(s). (0 não, 1 sim)

Exemplo para consultar os dados

[GET] http://ip.do.cliente:porta/ws_rest/public/api/posicaoVeiculo?IdPosicao=999&Placa=ABC1234&DataCadastroI=01/05/2019&DataCadastroF=31/05/2019&Documento=29872062000175

Exemplo para consultar as posições de um veículo em específico:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/posicaoVeiculo?IdPosicao=999&Placa=ABC1234&Documento=29872062000175

Exemplo para consultar as posições de todos os veículos de um transportador:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/posicaoVeiculo?IdPosicao=999&Documento=29872062000175

Exemplo para consultar as posições de todos os veículos de vários transportadores:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/posicaoVeiculo?IdPosicao=999&Documento=[29872062000175, 29872062000176, 29872062000177]

Exemplo para consultar somente a última posição de todos os veículos de um transportador:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/posicaoVeiculo?IdPosicao=999&Documento=29872062000175&SomenteUltimaPosicao=1

Observação

É altamente recomendável inserir o filtro de período.

Retorno JSON

{
    "Posicao": [
        {
            "idPosicao": 788365,
            "Placa": "ONX0001",
            "NumeroTerminal": "ONX0001",
            "Tecnologia": "ONIXSAT",
            "IdViagem": null,
            "DataBordo": "2018-09-14 13:16:37",
            "DataTecnologia": "2018-09-14 13:16:37",
            "DataCadastro": "2018-09-14 13:16:59",
            "Latitude": "-27.0000000000",
            "Longitude": "-51.6484375000",
            "DescricaoSistema": "7,452 KM DE TRADICIONAL MERC LTDA",
            "Cidade": "Chapecó",
            "UF": "SC",
            "DescricaoTecnologia": "",
            "Ignicao": "0",
            "Odometro": "0",
            "Velocidade": null,
            "RPM": "0"
        },
        {
            "idPosicao": 788404,
            "Placa": "ONX0001",
            "NumeroTerminal": "ONX0001",
            "Tecnologia": "ONIXSAT",
            "IdViagem": null,
            "DataBordo": "2018-09-14 13:17:07",
            "DataTecnologia": "2018-09-14 13:17:07",
            "DataCadastro": "2018-09-14 13:17:31",
            "Latitude": "-27.0000000000",
            "Longitude": "-51.6484375000",
            "DescricaoSistema": "7,452 KM DE TRADICIONAL MERC LTDA",
            "Cidade": "Chapecó",
            "UF": "SC",
            "DescricaoTecnologia": "",
            "Ignicao": "0",
            "Odometro": "0",
            "Velocidade": null,
            "RPM": "0"
        },
        {
            "idPosicao": 788440,
            "Placa": "ONX0001",
            "NumeroTerminal": "ONX0001",
            "Tecnologia": "ONIXSAT",
            "IdViagem": null,
            "DataBordo": "2018-09-14 13:17:07",
            "DataTecnologia": "2018-09-14 13:17:07",
            "DataCadastro": "2018-09-14 13:17:53",
            "Latitude": "-27.0000000000",
            "Longitude": "-51.6484375000",
            "DescricaoSistema": "7,452 KM DE TRADICIONAL MERC LTDA",
            "Cidade": "Chapecó",
            "UF": "SC",
            "DescricaoTecnologia": "",
            "Ignicao": "0",
            "Odometro": "0",
            "Velocidade": null,
            "RPM": "0"
        }
      ]
}

BuscarPosicaoTerminal

Retorna informações de Posições(es)

Parâmetros a serem passados na consulta:

Parâmetro	Tipo	Obrigatório	Descrição
IdPosicao:	inteiro	SIM	Id (código) da última posição recebida (para buscar as posteriores a este código).
Documento	texto	SIM	CNPJ da transportadora do veículo
Documento	lista(array)	SIM	CNPJ das transportadoras dos veículos. Limite de 10 transportadoras.
NumeroTerminal	texto	NÃO	Número do terminal que está posicionando
Tecnologia	inteiro	NÃO	Tecnologia a qual o terminal pertence
Qtde:	inteiro	NÃO	Quantidade de registro a ser recebida (máximo 1000, caso não informado máximo por padrão é 1000).
CodViag:	inteiro	NÃO	Código da viagem.
SomenteUltimaPosicao:	inteiro	NÃO	Buscar somente última posição do(s) veículo(s). (0 não, 1 sim)

Exemplo para consultar as posições de um terminal em específico:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/posicaoVeiculo?IdPosicao=01&NumeroTerminal=ONX0001&Tecnologia=ONIXSAT&Documento=29872062000175

Exemplo para consultar somente a última posição de todos os veículos de um transportador:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/posicaoVeiculo?IdPosicao=999?Documento=29872062000175&SomenteUltimaPosicao=1

Retorno JSON

{
    "Posicao": [
        {
            "idPosicao": 788365,
            "Placa": "ONX0001",
            "NumeroTerminal": "ONX0001",
            "Tecnologia": "ONIXSAT",
            "IdViagem": null,
            "DataBordo": "2018-09-14 13:16:37",
            "DataTecnologia": "2018-09-14 13:16:37",
            "DataCadastro": "2018-09-14 13:16:59",
            "Latitude": "-27.0000000000",
            "Longitude": "-51.6484375000",
            "DescricaoSistema": "7,452 KM DE TRADICIONAL MERC LTDA",
            "DescricaoTecnologia": "",
            "Ignicao": "0",
            "Odometro": "0",
            "Velocidade": null,
            "RPM": "0"
        },
        {
            "idPosicao": 788404,
            "Placa": "ONX0001",
            "NumeroTerminal": "ONX0001",
            "Tecnologia": "ONIXSAT",
            "IdViagem": null,
            "DataBordo": "2018-09-14 13:17:07",
            "DataTecnologia": "2018-09-14 13:17:07",
            "DataCadastro": "2018-09-14 13:17:31",
            "Latitude": "-27.0000000000",
            "Longitude": "-51.6484375000",
            "DescricaoSistema": "7,452 KM DE TRADICIONAL MERC LTDA",
            "DescricaoTecnologia": "",
            "Ignicao": "0",
            "Odometro": "0",
            "Velocidade": null,
            "RPM": "0"
        },
        {
            "idPosicao": 788440,
            "Placa": "ONX0001",
            "NumeroTerminal": "ONX0001",
            "Tecnologia": "ONIXSAT",
            "IdViagem": null,
            "DataBordo": "2018-09-14 13:17:07",
            "DataTecnologia": "2018-09-14 13:17:07",
            "DataCadastro": "2018-09-14 13:17:53",
            "Latitude": "-27.0000000000",
            "Longitude": "-51.6484375000",
            "DescricaoSistema": "7,452 KM DE TRADICIONAL MERC LTDA",
            "DescricaoTecnologia": "",
            "Ignicao": "0",
            "Odometro": "0",
            "Velocidade": null,
            "RPM": "0"
        }
      ]
}

BuscarPosicaoVeiculoViagem

Retorna últimas posições dos veículos durante as viagens em andamento

Parâmetros a serem passados na consulta:

Parâmetro	Obrigatório	Descrição
Documento:	SIM	CNPJ do transportador/embarcador.

Exemplo para consultar as posições:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/ultima-posicao-viagem?Documento=50.128.278/0001-17

Retorno JSON

                    {
                        "viagem": [
                            {
                                "placa": "POF9266",
                                "posicoesViagem": {
                                    "dataPosicao": "2019-05-28 17:26:24",
                                    "placa": "POF9266",
                                    "placaCarreta": "XDF3430",
                                    "descricaoLocal": "CAMPINAS-SP PRAX. RUA JOAO COELHO",
                                    "statusCarga": "EM VIAGEM",
                                    "coordenada": "-24.8522000000, -42.1576000000",
                                    "rastreadora": null,
                                    "motorista": "JOÃO PERREIRA",
                                    "contatoMotorista": [
                                        {
                                            "texto": "JOÃO PERREIRA",
                                            "telefone": "(19) 98885-5555",
                                            "radio": null
                                        }
                                    ],
                                    "notasFiscais": []
                                }
                            },
                            {
                                "placa": "POF7C00",
                                "posicoesViagem": {
                                    "dataPosicao": "2019-05-28 17:27:37",
                                    "placa": "POF7C00",
                                    "placaCarreta": "XWS8349",
                                    "descricaoLocal": "ALTO TAQUARI-MT MT-100",
                                    "statusCarga": "EM VIAGEM",
                                    "coordenada": "-12.8196000000, -44.2857000000",
                                    "rastreadora": null,
                                    "motorista": "JOSÉ BONIFÁCIO",
                                    "contatoMotorista": [
                                        {
                                            "texto": "JOSÉ BONIFÁCIO",
                                            "telefone": "04133235555",
                                            "radio": null
                                        }
                                    ],
                                    "notasFiscais": []
                                }
                            },
                            ...
                        ]
                    }

BuscaUltimaPosicaoVeiculo

Retorna informações de Posições(es)

Para consultar as posições de um veículo em específico deve ser infromado na URL os seguintes parâmetros:

Parâmetro	Obrigatório	Descrição
IdPosicao:	SIM	Id (código) da última posição recebida (para buscar as posteriores a este código).
Documento	SIM	CNPJ da transportadora do veículo
Placa:	NÃO	Placa do veículo.
Qtde:	NÃO	Quantidade de registro a ser recebida (máximo 1000, caso não informado máximo por padrão é 1000).
CodViag:	NÃO	Código da viagem.

Exemplo para consultar as posições de um veículo em específico:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/ultimaPosicaoVeiculo?IdPosicao=999&Placa=ABC1234

Exemplo para consultar as posições de todos os veículos:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/ultimaPosicaoVeiculo?IdPosicao=999

Retorno JSON

{
    "Posicao": [
        {
            "idPosicao": 788365,
            "Placa": "ONX0001",
            "NumeroTerminal": "ONX0001",
            "Tecnologia": "ONIXSAT",
            "IdViagem": null,
            "DataBordo": "2018-09-14 13:16:37",
            "DataTecnologia": "2018-09-14 13:16:37",
            "DataCadastro": "2018-09-14 13:16:59",
            "Latitude": "-27.0000000000",
            "Longitude": "-51.6484375000",
            "DescricaoSistema": "7,452 KM DE TRADICIONAL MERC LTDA",
            "Cidade": "Chapecó",
            "UF": "SC",
            "DescricaoTecnologia": "",
            "Ignicao": "0",
            "Odometro": "0",
            "Velocidade": null,
            "RPM": "0"
        }
      ]
}

BuscaUltimaPosicaoTerminal

Retorna informações de Posições(es)

Parâmetros a serem passados na consulta:

Parâmetro	Obrigatório	Descrição
IdPosicao:	SIM	Id (código) da última posição recebida (para buscar as posteriores a este código).
Documento	SIM	CNPJ da transportadora do veículo
NumeroTerminal	NÃO	Número do terminal que está posicionando
Tecnologia	NÃO	Tecnologia a qual o terminal pertence (só pode ser utilizado junto com o filtro NumeroTerminal)
Qtde:	NÃO	Quantidade de registro a ser recebida (máximo 1000, caso não informado máximo por padrão é 1000).
CodViag:	NÃO	Código da viagem.

Exemplo para consultar as posições de um terminal em específico:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/ultimaPosicaoVeiculo?IdPosicao=01&NumeroTerminal=ONX0001&Tecnologia=ONIXSAT

Exemplo para consultar as posições de todos os terminais

[GET] http://ip.do.cliente:porta/ws_rest/public/api/ultimaPosicaoVeiculo?IdPosicao=999

Retorno JSON

                    {
                        "Posicao": [
                            {
                                "idPosicao": 788365,
                                "Placa": "ONX0001",
                                "NumeroTerminal": "ONX0001",
                                "Tecnologia": "ONIXSAT",
                                "IdViagem": null,
                                "DataBordo": "2018-09-14 13:16:37",
                                "DataTecnologia": "2018-09-14 13:16:37",
                                "DataCadastro": "2018-09-14 13:16:59",
                                "Latitude": "-27.0000000000",
                                "Longitude": "-51.6484375000",
                                "DescricaoSistema": "7,452 KM DE TRADICIONAL MERC LTDA",
                                "DescricaoTecnologia": "",
                                "Ignicao": "0",
                                "Odometro": "0",
                                "Velocidade": null,
                                "RPM": "0"
                            }
                          ]
                    }

BuscarUltimoRecebimentoPeriferico

Retorna informações de Posição(ões)

Parâmetros a serem passados na consulta:

Parâmetro	Obrigatório	Descrição
Documento	NÃO	CPF/CNPJ Transportador do veículo (se em viagem) ou do proprietário (sem viagem)
Placa	NÃO	Placa de veículo
Qtde	NÃO	Quantidade de registro a serem retornados
GrupoVisualizacao	NÃO	Filtro opcional para aplicar ou não um filtro por grupo de visualização de veículos. Valores 1= Aplicar Grupo. 0 = Não aplicar. Caso não seja informado este parâmetro, não será aplicado filtro de grupo de visualização
PerifericosPadroes	NÃO	Filtro opcional em formato de lista (array) para definir quais periféricos deseja-se retornar
UltCodigo	NÃO	Código do último registro inserido (para buscar registros posteriores a este código).

Exemplo para consultar os últimos registros, sem parâmetros

[GET] http://ip.do.cliente:porta/ws_rest/public/api/ultimoperiferico

Exemplo para consultar os últimos registros, com parâmetros

[GET] http://ip.do.cliente:porta/ws_rest/public/api/ultimoperiferico?Documento=111&PerifericosPadroes=[8,11,30]&Qtde=100&GrupoVisualizacao=1

Retorno JSON

                    {
                        "recebimentos_perifericos": [
                            {
                                "Codigo": 1,
                                "Placa": "ABC1234",
                                "NumeroTerminal": "xxxxxxxx",
                                "Tecnologia": "ONIXSAT",
                                "PerifericoPadrao": "EVENTO DE TEMPERATURA",
                                "Violado": "N",
                                "Valor": "88",
                                "DataComputadorBordo": "07/12/2020 02:12:09",
                                "DataTecnologia": "07/12/2020 02:20:09",
                                "DataCadastro": "07/12/2020 02:20:09",
                                "DescricaoSistema": "3,604 KM DE EMPORIO MORANA COM PROD ALIM LTDA",
                                "Latitude": "-23.6391666667",
                                "Longitude": "-47.0150000000",
                                "Cidade": "SAO PAULO"
                            }
                        ]
                    }

BuscarVersoesTecnologia

Retorna informações de Versões das Tecnologias

Parâmetros a serem passados na consulta:

Parâmetro	Obrigatório	Descrição
Tecnologia	NÃO	Descrição da Tecnologia da versão

Exemplo para consultar as versões de uma Tecnologia em específico:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/versaoTecnologia?Tecnologia=ONIXSAT

Exemplo para consultar os dados de todas versões de tecnologia

[GET] http://ip.do.cliente:porta/ws_rest/public/api/versaoTecnologia

Retorno JSON

                    {
                        "versao_tecnologia": [
                            {
                                "codigo": 1,
                                "descricao": "ONIXSAT EQ.1 - 1.01",
                                "versao": "EQ.1 - 1.01",
                                "tecnologia": "ONIXSAT"
                            },
                            {
                                "codigo": 2,
                                "descricao": "ONIXSAT EQ.1 - 1.02",
                                "versao": "EQ.1 - 1.02",
                                "tecnologia": "ONIXSAT"
                            }
                          ]
                    }

BuscarRota

Retorna informações das Rotas da empresa do usuário de consumo

Parâmetros a serem passados na consulta:

Parâmetro	Obrigatório	Descrição
UltCodigo	NÃO	Código da última Rota recebida (para buscar as posteriores a este código).
RotaCodigo	NÃO	Código da Rota
dataAlteracao	NÃO	Data de Alteração da Rota
RetornarPolyline	NÃO	Adiciona as coordenadas da rota
RetornarInstrucoes	NÃO	Adiciona as instruções da rota
valores_frete	NÃO	Adiciona valores de frete da rota
Deve ser passado ao menos um dos parâmetros entre UltCodigo e RotaCodigo, caso a busca seja em lote (UltCodigo) o lote se limita em 100 registros

Exemplo para consultar os dados de uma Rota em específico:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/rota?RotaCodigo=123

Exemplo para consultar os dados de Rota em lotes de 100 registros

[GET] http://ip.do.cliente:porta/ws_rest/public/api/rota?UltCodigo=1

Exemplo para consultar os dados de Rota a partir de uma determinada data de alteração

[GET] http://ip.do.cliente:porta/ws_rest/public/api/rota?dataAlteracao=10/09/2018 11:45:00

Exemplo para retornar os dados das coordenadas da rota (encodado com padrão Google)

[GET] http://ip.do.cliente:porta/ws_rest/public/api/rota?RetornarPolyline=true

Exemplo para retornar os dados das instruções da rota

[GET] http://ip.do.cliente:porta/ws_rest/public/api/rota?RetornarInstrucoes=true

Exemplo para retornar os dados de valores de frete para rota

[GET] http://ip.do.cliente:porta/ws_rest/public/api/rota?valores_frete=S

Retorno JSON

{
    "rotas": [
        {
            "id_rota": 3952,
            "descricao": "43285- ",
            "distancia": "15274.66",
            "data_cadastro": "2018-10-08 09:48:53",
            "coordenadas": "peapCjrl{GtlBfjEdPd_@jDvI|AdIlCbOn@~M|A`]jDbt@|C|LjD`GfMtI~OvJj`@r]",
            "instrucoes": [
                "Passo 1: Siga na direção leste para a Av. Leopoldo Sander",
                "Passo 2: Vire à esquerda em direção à Ac. Ernani Sander",
                "Passo 3: Vire à esquerda na Ac. Ernani Sander",
                "Passo 4: Curva suave à esquerda na Av. Leopoldo Sander",
                "Passo 5: Av. Leopoldo Sander faz uma curva suave à direita e se torna Av. Leopoldo Sander",
                "Passo 6: Na rotatória, pegue a 4º saída para a BR-480 em direção a Xanxerê / São M. do Oeste / Rod. BR-282",
                "Passo 7: Continue em frente para permanecer na BR-480",
                "Passo 8: Na rotatória, pegue a 1º saída para a BR-282 / BR-480",
                "Passo 9: Vire à direita",
                "Passo 10: Vire à direita",
                "Passo 11: Curva acentuada à esquerda na R. Alberto Maggioni",
                "Passo 12: Vire à direita em direção à Av. Fermino Tozzo",
                "Passo 13: Vire à esquerda na Av. Fermino Tozzo",
                "Passo 14: Vire à esquerda na Av. Fermino Tozzo Passe por 1 rotatória O destino estará à esquerda",
                "Passo 15: Siga na direção nordeste na Av. Fermino Tozzo em direção à R. Patrício Dal Santo",
                "Passo 16: Vire à direita na BR-282 / BR-480",
                "Passo 17: Na rotatória, pegue a 2º saída e mantenha-se na BR-282 / BR-480",
                "Passo 18: Na rotatória, pegue a 1º saída para a Av. Plínio Arlíndo de Nes",
                "Passo 19: Na rotatória, pegue a 3º saída para a R. André Lunardi",
                "Passo 20: Continue para Av. Giácomo Lunardi O destino estará à direita"
            ],
            "valores_frete": [
                {
                    "tipo_veiculo": null,
                    "tipo_carroceria": null,
                    "valor_frete_fechado": "0.00",
                    "valor_frete": "0.00",
                    "valor_pedagio": "0.00",
                    "valor_ajudante": "0.00",
                    "valor_motorista_adicional": "0.00",
                    "valor_fiscais_adicionais": "0.00",
                    "valor_km_adicionais": "0.00"
                },
                {
                    "tipo_veiculo": null,
                    "tipo_carroceria": null,
                    "valor_frete_fechado": "0.00",
                    "valor_frete": "0.00",
                    "valor_pedagio": "0.00",
                    "valor_ajudante": "0.00",
                    "valor_motorista_adicional": "0.00",
                    "valor_fiscais_adicionais": "0.00",
                    "valor_km_adicionais": "0.00"
                }
            ],
            "pontos_rota": [
                {
                    "sequencia": 1,
                    "referencia": 12803257,
                    "descricao_local": "ORIGEM CARGA",
                    "tipo_local": 4,
                    "tipo_local_descricao": "ORIGEM",
                    "latitude": "-27.1125032348",
                    "longitude": "-52.5643014908",
                    "raio": "500.00000",
                    "area": null,
                    "area_descricao": null
                },
                {
                    "sequencia": 2,
                    "referencia": 09807856,
                    "descricao_local": "TRANSPORTADORA DA COLETA",
                    "tipo_local": 3,
                    "tipo_local_descricao": "ENTREGA",
                    "latitude": "-25.0925192000",
                    "longitude": "-50.1342357000",
                    "raio": "500.00000",
                    "area": null,
                    "area_descricao": null
                },
                {
                    "sequencia": 3,
                    "referencia": 09763523,
                    "descricao_local": "DESTINO DESCARGA",
                    "tipo_local": 5,
                    "tipo_local_descricao": "DESTINO",
                    "latitude": "-21.5900000000",
                    "longitude": "-42.5005555556",
                    "raio": "500.00000",
                    "area": null,
                    "area_descricao": null
                }
            ]
        }
    ]
}

BuscarEventos

Retorna informações dos eventos gerados no sistema trafegus que estejam com o item de PGR com a flag Retornar via WS ativa

Por padrão são retornados eventos para todos os terminais (ativos e inativos), se deseja restringir a consulta para apenas terminais ativos, é necessário desabilitar configuração de sistema chamada 'Buscar Eventos de Terminais Inativos (WS)'

É obrigatório informar a DataInicial e DataFinal ou UltCodigo

Parâmetros a serem passados na consulta:

Parâmetro	Obrigatório	Descrição
UltCodigo	SIM	Código do último Eventos recebido (para buscar as posteriores a este código).
Placa	NÃO	Placa do Veículo
CodViag	NÃO	Código da Viagem
Transportador	NÃO	Código do Transportador
DataInicial	NÃO	Data de Inicio
DataFinal	NÃO	Data de Fim
tipoEvento	NÃO	Código do tipo de evento

Exemplo para consultar os dados de uma Placa, Viagem ou Transportador em específico:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/eventos?UltCodigo=1&Placa=PLA0001&CodViag=141&Transportador=4532&DataInicial=01/01/2024&DataFinal=01/01/2024

Exemplo para consultar os dados de Eventos em lotes de 1000 registros

[GET] http://ip.do.cliente:porta/ws_rest/public/api/eventos?UltCodigo=1

Exemplo para consultar os dados por um tipo de evento, podendo colocar até 20 números inteiros:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/eventos?UltCodigo=1&tipoEvento=[32, 18]

Retorno JSON

{
    "eventos": [
        {
            "id_evento": 43457,
            "tipo_evento": 113,
            "descricao_tipo_evento": "EVENTO DE MACRO DE INICIO DE PERNOITE",
            "descricao": "INICIO DE PERNOITE.",
            "codigo_pgr": 2360,
            "pgr": "CARGA E DESCARGA",
            "placa": 9,
            "numero_terminal": "ONX0001",
            "tecnologia": "ONIXSAT",
            "data_cadastro": "2018-10-08 09:41:11",
            "data_bordo": "2018-10-02 11:34:29",
            "posicao": "0.600 KM DE PT. EXPRESSO CHAPECO -CHAPECO/SC",
            "latitude": "-27.1125032348",
            "longitude": "-52.5643014908",
            "codigo_viagem": 9511,
            "cnpj_transportador": "71890785000163",
            "nome_transportador": "ITS ME MARIO",
            "cnpj_proprietario": "71890785000163",
            "nome_proprietario": "ITS ME MARIO",
            "cpf_motorista": "055830540-77",
            "nome_motorista": "ALGUEM",
            "estacao_operador": "5 - OPERACAO COUROS",
            "pontuacao_evento": 2500,
            "hodometro": 1000
        },
        {
            "id_evento": 43454,
            "tipo_evento": 113,
            "descricao_tipo_evento": "EVENTO DE MACRO DE INICIO DE PERNOITE",
            "descricao": "INICIO DE PERNOITE.",
            "codigo_pgr": 2360,
            "pgr": "CARGA E DESCARGA",
            "placa": 9,
            "numero_terminal": "ONX0001",
            "tecnologia": "ONIXSAT",
            "data_cadastro": "2018-10-08 09:37:19",
            "data_bordo": "2018-10-02 11:34:29",
            "posicao": "0.600 KM DE PT. EXPRESSO CHAPECO -CHAPECO/SC",
            "latitude": "-27.1125032348",
            "longitude": "-52.5643014908",
            "codigo_viagem": 9511,
            "cnpj_transportador": "71890785000163",
            "nome_transportador": "ITS ME MARIO",
            "cnpj_proprietario": "71890785000163",
            "nome_proprietario": "ITS ME MARIO",
            "cpf_motorista": "055830540-77",
            "nome_motorista": "ALGUEM",
            "estacao_operador": "5 - OPERACAO COUROS",
            "pontuacao_evento": 2500,
            "hodometro": 1100
        }
    ]
}

BuscarNaoConformidade

Retorna informações dos Não Conformidades geradas no sistema trafegus

Parâmetros a serem passados na consulta:

Parâmetro	Obrigatório	Descrição
UltCodigo	SIM	Código da última Não Conformidade recebida (para buscar as posteriores a este código).
Placa	NÃO	Placa do Veículo
CodViag	NÃO	Código da Viagem

Exemplo para consultar os dados de uma Placa ou Viagem em específico:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/naoconformidades?UltCodigo=1&Placa=PLA0001&CodViag=141

Exemplo para consultar os dados de Não Conformidades em lotes de 1000 registros

[GET] http://ip.do.cliente:porta/ws_rest/public/api/naoconformidades?UltCodigo=1

Retorno JSON

{
    "Eventos": [
        {
            "idNC": 152744,
            "TipoNC": 7,
            "DescricaoTipoNC": "EXEMPLO DESCRICAO NC",
            "Placa": "ABC1234",
            "Descricao": "VEíCULO ONX0002 GEROU EVENTO DE BOTAO DE PANICO",
            "DataCadastro": "2022-10-04 16:10:27",
            "CodigoViagem": 27730,
            "nome_embarcador": "TRANS FUTURA",
            "descricao_evento": "BOTAO DE PANICO",
            "nome_proprietario": "JUVENAL DOS CHECKLIST",
            "Transportador": "TRANSPORTES",
            "Motorista": "MOTORISTA 1",
            "DataInicioViagem": "2022-10-03 08:43:51",
            "DataFimViagem": "2022-10-03 08:47:20",
            "Tratamento": "TRATAMENTO",
            "Usuario": "USUARIO 1",
            "ornc_esis_codigo": null, -- (INTERNO)
            "id_evento": null, -- (INTERNO)
            "ornc_data_leitura_gr": null, -- (INTERNO)
            "ornc_data_leitura_site": null, -- (INTERNO)
            "ornc_usua_pfis_pess_oras_codigo": 7, -- (INTERNO)
            "usua_login": "SUPORTE", -- (INTERNO)
            "usua_pess_nome": "TRANS SUP", -- (INTERNO)
            "data_alteracao": "2022-10-04 16:10:27" -- (INTERNO)
        },
        {
            "idNC": 2,
            "TipoNC": 13,
            "DescricaoTipoNC": "NAO CONFORMIDADE DO SISTEMA",
            "Placa": "ONX0002",
            "Descricao": "VEíCULO ONX0002 GEROU EVENTO DE BOTAO DE PANICO AS 05/02/2018 17:02:37 NAS PROXIMIDADES DE 0,043 KM DE P. XAXIM - XAXIM/SC :",
            "DataCadastro": "2018-07-12 16:24:39",
            "CodigoViagem": null,
            "nome_embarcador": "TRANS FUTURA",
            "descricao_evento": "BOTAO DE PANICO",
            "nome_proprietario": null,
            "Transportador": null,
            "Motorista": null,
            "DataInicioViagem": null,
            "DataFimViagem": null,
            "Tratamento": "TRATAMENTO",
            "Usuario": "USUARIO 1",
            "ornc_esis_codigo": null, -- (INTERNO)
            "id_evento": null, -- (INTERNO)
            "ornc_data_leitura_gr": null, -- (INTERNO)
            "ornc_data_leitura_site": null, -- (INTERNO)
            "ornc_usua_pfis_pess_oras_codigo": 7, -- (INTERNO)
            "usua_login": "SUPORTE", -- (INTERNO)
            "usua_pess_nome": "TRANS SUP", -- (INTERNO)
            "data_alteracao": "2022-10-04 16:10:27" -- (INTERNO)
        },
        {
            "idNC": 3,
            "TipoNC": 7,
            "DescricaoTipoNC": "NAO CONFORMIDADE DO SISTEMA",
            "Placa": "ONX0002",
            "Descricao": "VEíCULO DESVIOU ROTA AS 05/02/2018 17:02:37 NAS PROXIMIDADES DE 0,043 KM DE P. XAXIM - XAXIM/SC :",
            "DataCadastro": "2018-07-12 16:27:41",
            "CodigoViagem": null,
            "nome_embarcador": "TRANS FUTURA",
            "descricao_evento": null,
            "nome_proprietario": null,
            "Transportador": null,
            "Motorista": null,
            "DataInicioViagem": null,
            "DataFimViagem": null,
            "Tratamento": "TRATAMENTO",
            "Usuario": "USUARIO 1",
            "ornc_esis_codigo": null, -- (INTERNO)
            "id_evento": null, -- (INTERNO)
            "ornc_data_leitura_gr": null, -- (INTERNO)
            "ornc_data_leitura_site": null, -- (INTERNO)
            "ornc_usua_pfis_pess_oras_codigo": 7, -- (INTERNO)
            "usua_login": "SUPORTE", -- (INTERNO)
            "usua_pess_nome": "TRANS SUP", -- (INTERNO)
            "data_alteracao": "2022-10-04 16:10:27" -- (INTERNO)
        }
    ]
}

BuscarNaoConformidadeMotorista

Retorna informações dos Não Conformidades Motorista geradas no sistema trafegus

Parâmetros a serem passados na consulta:

Parâmetro	Obrigatório	Descrição
ultimoCodigo	NÃO	Código da última Não Conformidade Motorista recebida.
cpfMotorista	NÃO	Documento CPF do Motorista
documentoClienteSupensao	NÃO	Documento CPF/CNPJ do Cliente Suspensão
documentoTransportador	NÃO	Documento CNPJ do Transportador

Exemplo para consultar os dados de uma Cliente/Transportador/Motorista específico (Máximo 1000 registros):

[GET] http://ip.do.cliente:porta/ws_rest/public/api/naoconformidademotorista?cpfMotorista=87259087099&ultimoCodigo=52

[GET] http://ip.do.cliente:porta/ws_rest/public/api/naoconformidademotorista?documentoClienteSupensao=20101637000199

[GET] http://ip.do.cliente:porta/ws_rest/public/api/naoconformidademotorista?documentoTransportador=84447052000199

Exemplo para consultar os dados de Não Conformidade Motorista em lotes de 1000 registros

[GET] http://ip.do.cliente:porta/ws_rest/public/api/naoconformidademotorista?ultimoCodigo=1

Retorno JSON

{
    "sucesso": [
        {
            "codigo": 52,
            "nome_cliente_suspensao": "EMBARCADOR FILIAL FILIAL",
            "doc_cliente_suspensao": "20.101.637\/0001-99",
            "nome_motorista": "EVTO BOGIS",
            "cpf_motorista": "872.590.999-72",
            "situacao": "BLOQUEADO",
            "bloqueado_ate": "",
            "necessidade_liberacao": "NAO",
            "nome_transportador": null,
            "doc_transportador": null,
            "motivos_supensao": [
                {
                    "codigo": 242,
                    "descricao": "Dossiê Motorista"
                }
            ],
            "observacao": null,
            "motivo_interno": null,
            "codigo_modulo_elearning": 7
        },
        {
            "codigo": 53,
            "nome_cliente_suspensao": "GERENCIADORA DO PAULO",
            "doc_cliente_suspensao": "02.181.815\/0001-99",
            "nome_motorista": "EVAIR",
            "cpf_motorista": "999.700.409-01",
            "situacao": "BLOQUEADO",
            "bloqueado_ate": "",
            "necessidade_liberacao": "NAO",
            "nome_transportador": null,
            "doc_transportador": null,
            "motivos_supensao": [
                {
                    "codigo": 226,
                    "descricao": "Descumprimento das Regras de Plano de Gerenciamento"
                },
                {
                    "codigo": 227,
                    "descricao": "Descumprimento das Regras Operação Específica"
                }
            ],
            "observacao": null,
            "motivo_interno": null,
            "codigo_modulo_elearning": 23
        },
        {
            "codigo": 54,
            "nome_cliente_suspensao": "TRANSPORTES VALIDACAO",
            "doc_cliente_suspensao": "84.447.052\/0001-99",
            "nome_motorista": "TESTE APP LETHI",
            "cpf_motorista": "999.597.770-99",
            "situacao": "LIBERADO",
            "bloqueado_ate": "29\/06\/2022 10:00:00",
            "necessidade_liberacao": "NAO",
            "nome_transportador": null,
            "doc_transportador": null,
            "motivos_supensao": null,
            "observacao": "OBS*",
            "motivo_interno": "MOTIVO INTERNO 123",
            "codigo_modulo_elearning": 11
        },
        {
            "codigo": 55,
            "nome_cliente_suspensao": "GERENCIADORA DA VIDA1",
            "doc_cliente_suspensao": "71.790.712\/0001-99",
            "nome_motorista": "MOTORISTA PARA NC",
            "cpf_motorista": "098.999.160-99",
            "situacao": "BLOQUEADO",
            "bloqueado_ate": "",
            "necessidade_liberacao": "NAO",
            "nome_transportador": null,
            "doc_transportador": null,
            "motivos_supensao": [
                {
                    "codigo": 272,
                    "descricao": "Dossiê Motorista"
                }
            ],
            "observacao": null,
            "motivo_interno": null,
            "codigo_modulo_elearning": 6
        },
        {
            "codigo": 56,
            "nome_cliente_suspensao": "EMBARCA QUASE TUDO",
            "doc_cliente_suspensao": "35.261.222\/0001-99",
            "nome_motorista": "EVAIR DE SOUZA",
            "cpf_motorista": "445.999.740-99",
            "situacao": "LIBERADO",
            "bloqueado_ate": "12\/07\/2022 15:59:00",
            "necessidade_liberacao": "NAO",
            "nome_transportador": null,
            "doc_transportador": null,
            "motivos_supensao": [
                {
                    "codigo": 277,
                    "descricao": "falsesda dss d"
                }
            ],
            "observacao": null,
            "motivo_interno": null,
            "codigo_modulo_elearning": 3
        }
    ]
}

BuscarModulosElearning

Retorna informações de Módulos E-Learning geradas no sistema trafegus

Exemplo para consultar os dados de Módulo E-Learning:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/moduloselearning

Retorno JSON

{
    "success": {
        "data": [
            {
                "codigo": 7,
                "nome_modulo": "TESTE 2",
                "status": "INATIVO"
            },
            {
                "codigo": 6,
                "nome_modulo": "TESTE 3",
                "status": "ATIVO"
            },
            {
                "codigo": 8,
                "nome_modulo": "TESTE WEB",
                "status": "INATIVO"
            },
            {
                "codigo": 9,
                "nome_modulo": "TESTE WEB QQ",
                "status": "ATIVO"
            },
            {
                "codigo": 10,
                "nome_modulo": "TESTE WEB QQQ",
                "status": "INATIVO"
            },
            {
                "codigo": 11,
                "nome_modulo": "TESTE WEB ABC",
                "status": "ATIVO"
            },
            {
                "codigo": 12,
                "nome_modulo": "TESTE WEB ABC EDITADO",
                "status": "ATIVO"
            },
            {
                "codigo": 14,
                "nome_modulo": "NOVO TESTE ADICAO/EDICAO",
                "status": "ATIVO"
            },
            {
                "codigo": 13,
                "nome_modulo": "TESTE INPUTFILTER EDITADO EDITADO",
                "status": "ATIVO"
            },
            {
                "codigo": 15,
                "nome_modulo": "TESTE WS_REST EDITADO",
                "status": "INATIVO"
            },
            {
                "codigo": 16,
                "nome_modulo": "TESTE WEB EDITADO 123",
                "status": "INATIVO"
            },
            {
                "codigo": 19,
                "nome_modulo": "TESTE INSERT WEB EDITADO EDITADO",
                "status": "ATIVO"
            },
            {
                "codigo": 20,
                "nome_modulo": "&&%$#@$%*()_(*&*()?:/;/;",
                "status": "INATIVO"
            },
            {
                "codigo": 21,
                "nome_modulo": "STRING LENGTH  EDITADO",
                "status": "ATIVO"
            },
            {
                "codigo": 22,
                "nome_modulo": "NOVO TESTE INSERT WS_REST EDITADO WS",
                "status": "INATIVO"
            },
            {
                "codigo": 23,
                "nome_modulo": "NOVO TESTE INSERT WS_REST",
                "status": "ATIVO"
            },
            {
                "codigo": 24,
                "nome_modulo": "KADU - 01 - EDITADO",
                "status": "ATIVO"
            }
        ]
    },
    "error": []
}

BuscarEstaçãoRastreamento

Retorna informações de PGR(s)

Para consultar as estações de rastreamento:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/estacaoRastreamento

Retorno JSON

{
    "estacao_rastreamento": [
        {
            "codigo": 1,
            "descricao": "CHP_01"
        },
        {
            "codigo": 2,
            "descricao": "CHP_02"
        },
        {
            "codigo": 3,
            "descricao": "CHP_03"
        }}]
}

BuscarPesquisa

Retorna informações de Pesquisas(s)

Parâmetros a serem passados na consulta:

Parâmetro	Obrigatório	Descrição
UltCodigo	SIM	Código da última Pesquisa recebida (para buscar as posteriores a este código).
Documento	NÃO	Documento do proprietário da pesquisa
Objeto	NÃO	Objeto da pesquisa (Placa/CPF/CNPJ)
Para buscar um Objeto específico deve ser informado também o Documento do proprietário da pesquisa

Exemplo para consultar os dados de Pesquisas

[GET] http://ip.do.cliente:porta/ws_rest/public/api/historico-pesquisa?UltCodigo=1

Retorno JSON

{
    "Pesquisas": [
        {
            "valido": "INVALIDA",
            "codigo_pesquisa": 2670,
            "data_validade": null,
            "data_consulta": "20/12/2018 17:44:42",
            "StatusDescricao": "OBJETO PERTENCE A BLACKLIST DA GERENCIADORA",
            "Status": "BL",
            "FornecedorPesquisa": "3",
            "FornecedorDescricao": "TRAFEGUS PESQUISA",
            "Objeto": "LUC0001",
            "TipoObjeto": "MO",
            "Documento": "48765269000195",
            "DocumentoNome": "TRANS GABRIEL"
        }
    ]
}

BuscarDadosLogisticos

Retorna informações dos dados da frota

Obrigatórios:
Para consultar viagens de um transportador em específico, adicione o Documento ddo transportador na URL:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/frota?Documento=08879885554

Necessário informar o tipo de filtro da busca (UPOS = Ultima posicao/ INI = data inicio viagem/ FIM data de fim da viagem):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/frota?Tipo=UPOS

Necessário informar a data de início e fim do período da busca (dd/mm/yyyy hh:nn:ss):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/frota?DataInicio=01/01/2019 00:00:00&DataFim=02/01/2019 00:00:00

Exemplo da busca com dados obrigatórios:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/frota?Documento=08879885554&Tipo=UPOS&DataInicio=01/01/2019 00:00:00&DataFim=02/01/2019 00:00:00

Opcionais:
Para consultar uma viagem em específico, adicione o código da viagem na URL:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/frota?CodViag=123456

Para consultar uma Placa em específico, adicione a Placa na URL:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/frota?Placa=PLA0001

Retorno JSON

{
    "Frota": [
        {
            "viagem_codigo": 9803,
            "placa": "LUC0001",
            "frota": null,
            "rota_codigo": 4058,
            "rota_descricao": "TESTE VIAGEM FROTA",
            "viagem_status": "EM VIAGEM",
            "viagem_status_gr": "SM Efetivada",
            "percentual_viagem": "100",
            "previsao_fim_recalculada": null,
            "previsao_proximo_ponto": null,
            "horas_atraso": "",
            "status_atraso": "",
            "rota_distancia": "585.29",
            "distancia_percorrida": "585.29",
            "distancia_restante": 0,
            "documento_seguradora": null,
            "tempo_entrega_coleta": "0d 0h 0m 0s ",
            "tempo_viagem": "0d 1h 14m 2s ",
            "tempo_restante": "0d 0h 0m 0s ",
            "tipo_veiculo": "CAVALO",
            "origem": "SHOPPING PATIO CHAPECO",
            "chegada_origem": null,
            "saida_origem": null,
            "tempo_origem": "0d 0h 0m 0s ",
            "destino": "FLORIANOPOLIS-SC",
            "chegada_destino": null,
            "saida_destino": null,
            "tempo_destino": "0d 0h 0m 0s ",
            "motorista_nome": "DARLEI MENDONÇA DOS REIS",
            "motorista_contatos": null,
            "carreta_placa": null,
            "bitrem_placa": null,
            "transportador_contratado": "TRANSORTADOR DA VIAGEM",
            "previsao_status": "JA FINALIZOU A VIAGEM",
            "tipo_viagem": "TRANSFERENCIA",
            "entregas_realizadas": "",
            "quantidade_entregas": 2,
            "ultimo_evento_viagem_recebido": "CHEGADA NO LOCAL",
            "data_ultimo_evento": null,
            "ultimo_local_viagem_recebido": "SHOPPING PATIO CHAPECO",
            "local": "ORIGEM",
            "veiculo_status": "MOVIMENTO",
            "viagem_data_inicio": "16/01/2019 15:34:53 Qua",
            "viagem_data_fim": "16/01/2019 16:48:55 Qua",
            "viagem_previsao_inicio": "16/01/2019 15:34:53 Qua",
            "viagem_previsao_fim": null,
            "ultima_posicao": "manuealzao",
            "ultima_posicao_data": "15/01/2019 19:31:00 Ter",
            "velocidade": 20,
            "terminal_numero": "LUC0001",
            "transportador_viagem": "TRANS SUPINO",
            "embarcador_viagem": null,
            "tipo_operacao_veiculo": "",
            "tipo_operacao_viagem": null,
            "data_consolidacao_viagem": null,
            "numero_pedido_manifesto": null,
            "total_eventos_violacoes_temperatura": 0,
            "temperatura_status": "controle_ausente",
            "sensor_01": "N",
            "sensor_02": "N",
            "sensor_03": "N",
            "viagem_cliente": null,
            "embarques": null,
            "status_operacional": "VIAGEM FINALIZADA",
            "status_logistico": null,
            "cidade_origem": "GUARULHOS",
            "estado_origem": "SP",
            "referencia_destino": "SAO BERNARDO DO CAMPO-SP",
            "cidade_destino": "SAO BERNARDO DO CAMPO",
            "estado_destino": "AR",
            "latitude_ultima_posicao": "-26.9192365281",
            "longitude_ultima_posicao": "-53.1949612498",
            "uf_ultima_posicao": null
        }
    ]
}

O campo "viagem_status_gr" pode conter os seguintes valores:

SM Agendada
SM Efetivada
SM/Viagem Cancelada
SM Rejeitada
SM Aprovada
SM Finalizada
Aguardando
SM Checklist Iniciado
Checklist Finalizado
SM REAGENDADA
REABERTURA VIAGEM FINALIZADA
SM Desconforme

EnviarPesquisaCad

[POST] http://ip.do.cliente:porta/ws_rest/public/api/v1/pesquisa

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
TipoObjeto	1	texto (2)	Sim	Tipo de Objeto de Pesquisa (disponível na documentação no Tipo de Objeto de Pesquisa)
Documento	1	texto (50)	Sim	Documento do Transportador proprietário da pesquisa
Objeto	1	texto (50)	Sim	Objeto da pesquisa (Placa/CPF/CNPJ)
Renovacao	1	texto (1)	Sim	Renovação de Pesquisa (S/N)

Requisição para envio dos dados da Pesquisa

{
"pesquisas":[
    {
        "TipoObjeto": "TR",
        "Documento": "23412744000119",
        "Objeto": "23412744000119",
        "FornecedorPesquisa": "1",
        "Status": "IN",
        "NumeroLiberacao":"321333",
        "DataValidade":"2018-10-02 11:34:29"
    }
    ]

}

EnviarEventoTecnologia

Cadastra um evento de periférico para o terminal e tecnologia conforme a placa informada. A tecnologia e o terminal são buscados nas viagens em aberto que a placa está associada (caso houver) ou o padrão do veículo (associado no cadastro).

[POST] http://{{ip.do.cliente:porta}}/ws_rest/public/api/tecnologia/evento

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
eventos	0	array de objetos	Sim	Tag principal do JSON
tipo	1	Inteiro	Sim	Tipo do evento que deseja gerar (utilizado para buscar um evento padrão de periférico)
placa	1	texto (10)	Sim	Veículo para qual o evento será gerado.
descricao	1	texto (50)	Não	Texto alternativo para a descrição do evento. Padrão irá gerar com a descrição 'Evento Genérico da Tecnologia'
gerarEvento	1	Lógico	Não	Se irá gerar evento de violação (Padrão: true)

Requisição para envio dos eventos da Tecnologia

{
"eventos":[
         {
            "tipo": 1,
            "placa": "AAA0000",
            "descricao": "AUTORIZACAO DE ABERTURA DE BAU PELO GESTOR",
            "gerarEvento": true
        }
    ]
}

RETORNOS:

Retorno de sucesso da requisição

Status 200

{
    "success": {
        "cod": 0,
        "mensagem": "Evento(s) cadatrado(s)/inserido(s) com sucesso"
    },
    "error": []
}

Retorno de erro da requisição devido ao JSON que foi informado ser inválido e não ser possível corrigir o problema do JSON

Status 422

{
    "success": [],
    "error": {
        "codigo": -1, -- Código de erro não padronizado
        "mensagens": [
            {
                "tipo": "erro",
                "status": 422, -- Código de status da requisição (422: Erro tratado | 500: Erro não tratado)
                "texto": "O JSON de dados está inválido"
            }
        ]
    }
}

Retorno de erro da requisição devido a não haver dados ou o array de eventos estar vazio

Status 422

{
    "success": [],
    "error": {
        "codigo": -1, -- Código de erro não padronizado
        "mensagens": [
            {
                "tipo": "erro",
                "status": 422, -- Código de status da requisição (422: Erro tratado | 500: Erro não tratado)
                "texto": "Não foi informado nenhum dado na requisição ou array de eventos está vazio"
            }
        ]
    }
}

Retorno de erro da requisição devido ao tipo ser inválido (menor que 1 ou maior que 5)

Status 422

{
    "success": [],
    "error": {
        "codigo": -1, -- Código de erro não padronizado
        "mensagens": [
            {
                "tipo": "erro",
                "status": 422, -- Código de status da requisição (422: Erro tratado | 500: Erro não tratado)
                "texto": "Tipo {{tipo informado na requisição}} inválido"
            }
        ]
    }
}

Retorno de erro da requisição devido a falta de placa

Status 422

{
    "success": [],
    "error": {
        "codigo": -1, -- Código de erro não padronizado
        "mensagens": [
            {
                "tipo": "erro",
                "status": 422, -- Código de status da requisição (422: Erro tratado | 500: Erro não tratado)
                "texto": "Placa não informada"
            }
        ]
    }
}

Retorno de erro da requisição devido a placa não poder ser encontrada ou ainda não estar cadastrada

Status 422

{
    "success": [],
    "error": {
        "codigo": -1, -- Código de erro não padronizado
        "mensagens": [
            {
                "tipo": "erro",
                "status": 422, -- Código de status da requisição (422: Erro tratado | 500: Erro não tratado)
                "texto": "Veículo não encontrado para a placa {{placa informada na requisição}}"
            }
        ]
    }
}

Retorno de erro da requisição devido a não ser encontrado o terminal para a placa informada

Status 422

{
    "success": [],
    "error": {
        "codigo": -1, -- Código de erro não padronizado
        "mensagens": [
            {
                "tipo": "erro",
                "status": 422, -- Código de status da requisição (422: Erro tratado | 500: Erro não tratado)
                "texto": "Veículo não possui terminal vinculado em viagem ou no cadastro"
            }
        ]
    }
}

Retorno de erro da requisição ainda não tratado

Status 500

{
    "success": [],
    "error": {
        "codigo": -1, -- Código de erro não padronizado
        "mensagens": [
            {
                "tipo": "erro",
                "status": 500, -- Código de status da requisição (422: Erro tratado | 500: Erro não tratado)
                "texto": {{erro não tratado}} -- Erro de SQL, por exemplo, será exibido aqui
            }
        ]
    }
}

EnviarNFAvulsa

Método responsável pelo cadastramento de notas fiscais avulsas, ainda sem vínculo com viagem.

[POST] http://ip.do.cliente:porta/ws_rest/public/api/notafiscal

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
notafiscal	0	Array	Sim	Tag principal json
numero	1	string(200)	Sim	Número da nota
cnpj_emba	1	string(30)	Sim	CNPJ do Embarcador
documento_transportador	1	string(30)	Não	CNPJ / CPF do Transportador
documento_proximo_transportador	1	string(30)	Não	CNPJ / CPF do Próximo Transportador
remetente	1	objeto	Não	Remetente da nota fiscal
refe_descricao	2	string(200)	Sim	Descrição do remetente
refe_latitude	2	float	Não	Latitude do local
refe_longitude	2	float	Não	Longitude do local
cida_descricao_ibge	2	string(100)	Não	Cidade da origem ou código do IBGE (da cidade)
cep	2	string(8)	Não	CEP do Logradouro (Usar como auxilio para não duplicar)
destinatario	1	objeto	Não	Destinatário da nota fiscal
refe_descricao	2	string(200)	Sim	Descrição do destinatário
refe_latitude	2	float	Não	Latitude do local
refe_longitude	2	float	Não	Longitude do local
cida_descricao_ibge	2	string(100)	Não	Cidade da origem ou código do IBGE (da cidade)
cep	2	string(8)	Não	CEP do Logradouro (Usar como auxilio para não duplicar)
numeroConhecimento	1	string(200)	Não	Número do Conhecimento
numeroManifesto	1	string(200)	Não	Número Pedido / Manifesto
dataPrevisaoEntrega	1	datetime (01/06/2015 00:00:00)	Não	Data de previsão de entrega
valor	1	float	Sim	Valor da nota
status_operacional	1	string(100)	Não	Status Operacional

Requisição para envio dos dados de Notas Fiscais

{
    "notafiscal": [
        {
            "numero": "1234",
            "cnpj_emba": "4378954398787678",
            "documento_transportador": "432432432-12",
            "documento_proximo_transportador": "432432432-12",
            "remetente": {
                "refe_descricao": "ARENA CONDA",
                "refe_latitude": "-27.0707338178",
                "refe_longitude": "-52.6269900798",
                "cida_descricao_ibge": "CHAPECO",
                "cep": null
            },
            "destinatario": {
                "refe_descricao": "P. SAMUARA",
                "refe_latitude": "-29.0707338178",
                "refe_longitude": "-54.6269900798",
                "cida_descricao_ibge": "CHAPECO",
                "cep": null
            },
            "numeroConhecimento": "4535643",
            "numeroManifesto": "5432",
            "dataPrevisaoEntrega": "20/05/2020 19:16:39",
            "valor": 1870.5,
            "status_operacional": "DEVOLVIDA"
        }
    ]
}

Retorno em caso de Sucesso:



{
    "sucesso": [
        {
            "cod": "0",
            "codigo_nota_fiscal": 157,
            "mensagem": "operacao realizada com sucesso"
        }
    ],
    "success": [
        {
            "cod": "0",
            "codigo_nota_fiscal": 157,
            "mensagem": "operacao realizada com sucesso"
        }
    ],
    "error": []
}

Exemplos de retorno em caso de erro:

Campo nulo ou com valor inválido:



{
    "sucesso": [],
    "success": [],
    "error": {
        "embarcador": {
            "isEmpty": "O valor É obrigatório e não pode estar vazio"
        }
    }
}

Erro de validação:


{
    "sucesso": [],
    "success": [],
    "error": [
        {
            "cod": "14",
            "valor": "Exception",
            "campo": null,
            "mensagem": "Erro ao cadastrar nota fiscal. Já existe uma nota fiscal com esse número! (1234)"
        }
    ]
}

EnviarRoteiroAtividades

Método responsável pelo cadastramento de novos roteiros de atividades.

[POST] http://ip.do.cliente:porta/ws_rest/public/api/solicitacaochecklistroteiro

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Tipo	Obrigatório	Descrição
codigo_modelo_roteiro	integer	Não (com possível seleção automática)	Código do Modelo de Roteiro
descricao_roteiro	string(30)	Não	Descrição do Roteiro
codigo_tipo_roteiro	integer	Não	Código do Tipo do Roteiro
documento_solicitante	string(30)	Sim	CPF/CNPJ da Empresa Solicitante
placa_veiculo	string(10)	Não	Placa do Veículo
documento_usuario_executa	string(30)	Sim	CPF/CNPJ do usuário que irá executar o roteiro
data_validade	date (01/06/2021)	Não	Data de validade do roteiro
data_execucao_meta	date (01/06/2021)	Não	Data Meta limite para execução do roteiro

Requisição para envio dos dados

{
    "codigo_modelo_roteiro": 303,
    "descricao_roteiro": "Roteiro X",
    "codigo_tipo_roteiro": 1,
    "documento_solicitante": "84447052000109",
    "documento_usuario_executa": "630916020-60",
    "placa_veiculo": "ABC1234",
    "data_validade": "01/01/2021",
    "data_execucao_meta": "01/01/2021"
}

Retorno em caso de Sucesso:


{
    "success": {
        "sucesso": "ok",
        "codigo": 840
    },
    "error": []
}

Exemplos de retorno em caso de erro:

Campo nulo ou com valor inválido:


{
    "success": [],
    "error": {
        "codigo": -1,
        "mensagens": [
            {
                "tipo": "erro",
                "status": 400,
                "texto": "Placa inválida ou não encontrada"
            }
        ]
    }
}

EnviarUsuario

Método responsável pelo cadastramento de novos usuários.

[POST] http://ip.do.cliente:porta/ws_rest/public/api/usuario

Parâmetros a serem enviados para cadastrar um novo usuário:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
login	0	string(20)	Sim	Login do Usuário
senha	0	string(30)	Sim	Senha do Usuário
documento_empresa	0	string(30)	Sim	CPF/CNPJ da Empresa do Usuário
codigo_perfil	0	integer	Não	Código do Perfil do Usuário
email	0	string(10)	Não	E-mail do usuário
pessoa	0	objeto	-	Dados da pessoa
nome	1	string(10)	Sim	Nome do Usuário
documento	1	string(10)	Sim	CPF/CNPJ do Usuário
telefone	1	string(10)	Não	Telefone do Usuário

Requisição para envio dos dados

{
    "login": "teste.usuario",
    "senha": "123",
    "documento_empresa": "62.215.500/0001-06",
    "email": "teste@teste.com",
    "pessoa": {
        "nome": "USUARIO COM APP",
        "telefone": "(48) 88888-8888",
        "documento": "090.039.400-53",
    },
}

Retorno em caso de Sucesso:


{
    "success": {
        "codigo": 3116298,
        "status": "ok"
    },
    "error": []
}

Exemplos de retorno em caso de erro:

Erro de Validação:


{
    "success": [],
    "error": {
        "codigo": -1,
        "status": {
            "pessoa": {
                "usuarioJaExiste": "Este documento já está cadastrado a um usuário"
            }
        }
    }
}

EnvioMensagemCentralVeiculo

Método responsável pelo envio de mensagens ao motorista/veículo para disparo e inibição de eventos.

[POST] http://ip.do.cliente:porta/ws_rest/public/api/envioMensagemCentralVeiculo

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Tipo	Obrigatório	Descrição
veic_placa	string(15)	Não	Placa do veículo. Obrigatório quando numero_terminal e tecnologia forem null.
numero_terminal	string(30)	Não	Número terminal. Obrigatório quando veic_placa for null.
tecnologia	string(50)	Não	Tecnologia. Obrigatório quando veic_placa for null.
tipo_mensagem	integer	Sim	Tipo de Mensagem ( 1 = Macro / 2 = Mensagem Livre ).
texto	string(500)	Sim	Texto da mensagem / macro.
tipo_macro	integer	Não¹	Cadastro padrão de Tipos de Macros. Obrigatório quando tipo_mensagem for igual a 1.
numero_macro	string(100)	Não¹	Número do Macro. Obrigatório quando o tipo_mensagem for igual a 1.
mascara_macro	string(5000)	Não	Máscara Macro. Obrigatório quando o tipo_mensagem for igual a 1.
vinculo_externo	string(50)	Não	Vinculo Externo. Para relacionar com um código do sistema terceiro.

¹ - Caso o tipo_mensagem for igual a 1 ( Macro ) o campo tipo_macro deve estar associado ao numero_macro.

Requisição para envio dos dados

                    {
                        "mensagens": [
                            {
                                "veic_placa": "",
                                "numero_terminal": "TERMNAL02",
                                "tecnologia": "TECNOLOGIA DESCRICAO",
                                "tipo_mensagem": 1,
                                "texto": "TESTE MACRO",
                                "tipo_macro": 3,
                                "numero_macro": "151",
                                "mascara_macro": "TESTE: ___",
                                "vinculo_externo": "12345"
                            },
                            {
                                "veic_placa": "ABC0001",
                                "numero_terminal": "",
                                "tecnologia": "",
                                "tipo_mensagem": 2,
                                "texto": "INICIO DE VIAGEM",
                                "tipo_macro": 1,
                                "numero_macro": "",
                                "mascara_macro": "",
                                "vinculo_externo": ""
                            }
                        ]
                    }

Retorno em caso de Sucesso:

                    {
                        "success": {
                            "cod": 0,
                            "mensagem": "mensagem enviada com sucesso"
                        },
                        "error": []
                    }

Exemplos de retorno em caso de erro:

Erro de Validação:

                    {
                        "success": [],
                        "error": {
                            "cod": 0,
                            "mensagem": "Necessário informar um número de terminal e tecnologia ou uma placa de um veículo que possua terminal vinculado."
                        }
                    }

EnviarSolicitacaoCheckList

Método responsável pelo cadastramento de novas solicitações de checklist.

[POST] http://ip.do.cliente:porta/ws_rest/public/api/solicitacaochecklist

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Tipo	Obrigatório	Descrição
solicitacao	Array	Sim	Tag principal json
tipo	string(30)	Sim	Descrição do tipo de solicitação de checklist
placa_veiculo	string(10)	Sim	Placa do veículo
placa_carreta	string(10)	Não	Placa da carreta
terminal	string(25)	Sim	Número do terminal/rastreador
tecnologia	string(50)	Sim	Nome da tecnologia do rastreador
doc_solicitante	string(16)	Não	CPF/CNPJ do solicitante do checklist
doc_proprietario	string(16)	Sim	CPF/CNPJ do proprietário do checklist
doc_transportador	string(16)	Não	CPF/CNPJ do transportador do checklist
doc_embarcador	string(16)	Não	CNPJ do embarcador do checklist
doc_motorista	string(12)	Não	CPF do motorista do checklist
tipo_vinculo	string(20)	Não	Descrição tipo de vínculo contratual
observacao	string(150)	Não	Observação do Checklist
checklist_somente_carreta	string(1)	Não	Campo informativo para cadastro de checklist somente do veículo carreta, os campos placa_veiculo e terminal não são obrigatórios quando enviado o valor "S"

Requisição para envio dos dados

{
    "solicitacao": [
        {
            "tipo": "ROTINA",
            "placa_veiculo": "RRR0001",
            "placa_carreta": "CRT5555",
            "terminal": "MATRIX665",
            "tecnologia": "WRSAT",
            "doc_proprietario": "795620324-42",
            "doc_transportador": "06208105000117",
            "doc_embarcador": "07196139000100",
            "doc_motorista": "931808539-72",
            "tipo_vinculo": "FIXO",
            "observacao": "Observações da solicitação",
            "checklist_somente_carreta": "N"
        },
        {
            "tipo": "PRÉ-CARREGAMENTO",
            "placa_veiculo": "KADU7777",
            "placa_carreta": "CRT5555",
            "terminal": "TELELERICIA",
            "tecnologia": "TELEMONITORADOS",
            "doc_proprietario": "84447052000109",
            "doc_transportador": "07196139000100",
            "doc_embarcador": "07196139000100",
            "doc_motorista": "931808539-72",
            "tipo_vinculo": "FIXO",
            "observacao": "Observações da solicitação",
            "checklist_somente_carreta": "N"
        },
        {
            "tipo": "PREMANUTENCAO",
            "placa_veiculo": "ABC0002",
            "terminal": "TELELERICIA",
            "tecnologia": "TELEMONITORADOS",
            "doc_solicitante": "5296072-K",
            "doc_proprietario": "84447052000109",
            "doc_transportador": "07196139000100",
            "doc_embarcador": "07196139000100",
            "doc_motorista": "931808539-72",
            "tipo_vinculo": "FIXO",
            "observacao": "Observações da solicitação",
            "checklist_somente_carreta": "N"
        }
    ]
}

Retorno em caso de Sucesso e Erro:


{
    "sucesso": {
        "item-1": {
            "cod": 2729,
            "mensagem": "operacao realizada com sucesso"
        }
    },
    "success": {
        "item-1": {
            "cod": 2729,
            "mensagem": "operacao realizada com sucesso"
        }
    },
    "error": {
        "item-0": {
            "validacao": "Já existe uma solicitação de checklist pendente. Código: 2728"
        },
        "item-2": {
            "validacao": "Já existe uma solicitação de checklist pendente. Código: 2695"
        }
    }
}

EnviarViagemVuupt

Método responsável por receber um JSON no formato enviado pelo sistema da Vuupt e realizar o cadastro de uma SM na Trafegus.

[POST] http://ip.do.cliente:porta/ws_rest/public/api/viagem/vuupt

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Nível	Tipo	Obrigatório	Descrição
event	0	string	Sim	Evento integrado
payload	0	array	Sim	Array contendo origem, locais e destino
id	1	integer	Sim	Código externo da SM
start_location_base_id	1	integer	Sim	Utilizado para cadastro da origem da SM
end_location_base_id	1	integer	Sim	Utilizado para cadastro do destino da SM
activities	1	array	Sim	Array contendo os dados dos locais
type	2	string	Sim	Tipo da localização, sendo 'start', 'service' ou 'end'
service_id	2	integer	Sim	Utilizado para identificar o local (podendo ser null quando for type for start ou end)
agent	1	array	Sim	Array contendo dados do motorista
code	2	string	Sim	CPF do motorista
vehicle	1	array	Sim	Array contendo os dados do veiculo
license_plate	2	string	Sim	Placa do veículo

Requisição para cadastro de SM, posição, periféricos

                    {
                        "event": "Vuupt\\Events\\Route\\RouteUpdatedEvent",
                        "payload": {
                            "id": 5812,
                            "start_location_base_id": 160,
                            "end_location_base_id": 160,
                            "activities": [
                            {
                                "type": "start",
                                "service_id": null
                            },
                            {
                                "type": "service",
                                "service_id": 125540
                            },
                            {
                                "type": "service",
                                "service_id": 119487
                            },
                            {
                                "type": "end",
                                "service_id": null
                            }
                            ],
                            "agent": {
                            "code": "123.456.789-10"
                            },
                            "vehicle": {
                            "license_plate": "ABC1234"
                            }
                        }
                    }

Retorno em caso de Sucesso:

                    {
                        "Retorno": {
                            "codigo": "5",
                            "cod_viagem": 34
                        }
                    }

Exemplos de retorno em caso de erro:

Erro ao criar SM:

                    {
                        "Retorno": {
                            "codigo": 4,
                            "erro": "Erro ao criar SM. Veja mais detalhes no Json de retorno.",
                            "json_retorno": {
                                "sucesso": [],
                                "success": [],
                                "avisos": [],
                                "error": [
                                    {
                                        "cod_status": "0",
                                        "valor": "5812",
                                        "campo": "viag_codigo_externo",
                                        "cod_viagem_interno": 31,
                                        "mensagem": "Já existe uma viagem com esse código externo!"
                                    },
                                    {
                                        "cod_status": "0",
                                        "valor": "5812",
                                        "campo": "viag_codigo_externo",
                                        "cod_viagem_interno": 31,
                                        "mensagem": "Já existe uma viagem com esse código externo!"
                                    }
                                ]
                            }
                        }
                    }

Erro de evento não mapeado:

                    {
                        "Retorno": {
                            "codigo": "1",
                            "erro": "Evento inválido"
                        }
                    }

Erro de configuração de integração não encontrada:

                    {
                        "Retorno": {
                            "codigo": 2,
                            "erro": "Configuração de integração não encontrada."
                        }
                    }

Erro de campos obrigatórios:

                    {
                        "Retorno": {
                            "codigo": 3,
                            "erro": "Placa do veículo não informada."
                        }
                    }

Erro de login:

                    {
                        "Retorno": {
                            "codigo": "-1",
                            "erro": "Usuario não encontrado na base de dados ou senha incorreta"
                        }
                    }

Código -1: Retorno de erro de login.

Código 0: Demais erros.

Código 1: Retorno de erro de evento não mapeado.

Código 2: Retorno de erro de configuração de integração não encontrada/configurada.

Código 3: Retorno de erro de campos obrigatórios.

Código 4: Retorno de erro no cadastro da SM.

Código 5: Retorno de sucesso.

EnviarPessoaFisica

Método responsável pelo cadastramento de novas pessoas físicas.

[POST] http://ip.do.cliente:porta/ws_rest/public/api/pessoafisica

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

[POST] http://ip.do.cliente:porta/ws_rest/public/api/pessoafisica

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Tipo	Obrigatório	Descrição
cpf	texto (20)	Sim	CPF
nome	texto (50)	Sim	Nome
rg	texto (20)	Sim	RG
numero_pis	texto (20)	Não	PIS
sexo	texto (1)	Não	Sexo ('M' ou 'F')
matricula	texto (50)	Não	Matrícula
status	Constante	Não	1 = ATIVO 2 = INATIVO
logradouro	texto (200)	Não	Descrição do Logradouro
cep	texto (8)	Não	CEP do Logradouro
numero	texto (50)	Não	Número do Logradouro
complemento	texto (100)	Não	Descrição do Complemento do Logradouro
bairro	texto (100)	Não	Descrição do Bairro do Logradouro
cidade	texto (100)	Não	Cidade da origem ou código do IBGE (conforme tabela padrão do IBGE)
sigla_estado	texto (2)	Não	Sigla do Estado do Logradouro
pais	texto (50)	Não	País
nome_pai	texto (100)	Sim	Nome do Pai
nome_mae	texto (100)	Sim	Nome da Mãe
estado_civil	texto (1)	Não	C: CASADO S: SOLTEIRO D: DIVORCIADO V: VIÚVO
profissao	texto (50)	Não	Nome da Profissão
vinculo_contratual	inteiro	Não	Tipo de vínculo com a empresa do usuário da requisição

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
cpf	0	texto (20)	Sim	CPF
nome	0	texto (50)	Sim	Nome
rg	0	texto (20)	Sim	RG
numero_pis	0	texto (20)	Não	PIS
sexo	0	texto (1)	Não	Sexo ('M' ou 'F')
matricula	0	texto (50)	Não	Matrícula
status	0	Constante	Não	1 = ATIVO 2 = INATIVO
logradouro	0	texto (200)	Não	Descrição do Logradouro
cep	0	texto (8)	Não	CEP do Logradouro
numero	0	texto (50)	Não	Número do Logradouro
complemento	0	texto (100)	Não	Descrição do Complemento do Logradouro
bairro	0	texto (100)	Não	Descrição do Bairro do Logradouro
cidade	0	texto (100)	Não	Cidade da origem ou código do IBGE (conforme tabela padrão do IBGE)
sigla_estado	0	texto (2)	Não	Sigla do Estado do Logradouro
pais	0	texto (50)	Não	País
nome_pai	0	texto (100)	Sim	Nome do Pai
nome_mae	0	texto (100)	Sim	Nome da Mãe
estado_civil	0	texto (1)	Não	C: CASADO S: SOLTEIRO D: DIVORCIADO V: VIÚVO
profissao	0	texto (50)	Não	Nome da Profissão
vinculo_contratual	0	inteiro	Não	Tipo de vínculo com a empresa do usuário da requisição
numero_pis	0	texto (20)	Não	Número do PIS
data_nascimento	0	date (01/06/2015)	Não	Data Nascimento
emissor_rg	0	texto (10)	Não	Órgão Emissor do RG
estado_emissor_rg	0	texto (2)	Não	Sigla do estado emissor do RG
naturalidade_descricao_ibge	0	texto (100)	Não	Cidade de Naturalidade ou código do IBGE (conforme tabela padrão do IBGE)
naturalidade_uf_sigla	0	texto (2)	Não	Sigla estado naturalidade
transportadores	0	lista (array)	Não	Array de transportadores, podendo associar vários neste array
documento_transportador	1	texto (30)	Não	CPF/CNPJ do transportador
vinculo_contratual	1	inteiro	Não	Tipo de vínculo com o Transportador. 1=Fixo; 2=Agregado; 3=Terceiro
embarcadores	0	lista (array)	Não	Array de embarcadores, podendo associar vários neste array
documento_embarcador	1	texto (30)	Não	CNPJ do embarcador
vinculo_contratual	1	inteiro	Não	Tipo de vínculo com o Embarcador. 1=Fixo; 2=Agregado; 3=Terceiro
contatos	0	lista (array)	Não	Contatos da pessoa, podendo associar vários neste array
codigo	1	inteiro	Não	Código do contato, para fazer alterações no contato
texto	1	texto (100)	Sim	Nome do contato
email	1	texto (100)	Não	Email do contato
celular	1	texto (30)	Não	Celular do contato
fone1	1	texto (30)	Não	Telefone do contato
fone2	1	texto (30)	Não	Telefone secundário do contato

Requisição para envio dos dados

{
    "pessoafisica": [
        {
            "status": "1",
            "nome": "NOME TESTE",
            "cpf": "411.985.860-01",
            "matricula": "123",
            "data_nascimento": "30/11/1998",
            "nome_mae": "MAE",
            "nome_pai": "PAI",
            "rg": "20121033950",
            "data_emissao_rg": "30/11/2000",
            "emissor_rg": "SSP",
            "estado_emissor_rg": "SC",
            "estado_civil": "S",
            "logradouro": "ENDERECO",
            "numero_pis": "4387902408",
            "cep": "89817000",
            "numero": "44",
            "complemento": "ENDERECO",
            "bairro": "ENDERECO",
            "cidade": "CHAPECO",
            "naturalidade_descricao_ibge": "ITAPIRANGA",
            "naturalidade_uf_sigla": "SC",
            "sigla_estado": "SC",
            "pais": "Brasil",
            "profissao": "motorista",
            "sexo": "F",
			"vinculo_contratual": 1,
            "transportadores": [
                {
                    "documento_transportador": "84447052000109",
                    "vinculo_contratual": 1
                }
            ],
            "embarcadores": [
                {
                    "documento_embarcador": "35261222000142",
                    "vinculo_contratual": 1
                }
            ],
            "contatos": [
                {
                    "codigo": 8295,
                    "texto": "TESTE 1",
                    "fone": "49999999999",
                    "fone2": "49999999999",
                    "fone3": "49999999999",
                    "radio": null
                },
                {
                    "texto": "TESTE 2",
                    "fone": "49999999999",
                    "fone2": "49999999999",
                    "fone3": "49999999999",
                    "radio": null
                }
            ]
        }
    ]
}

Retorno em caso de Sucesso:

{
    "sucesso": [
        {
            "cod": "0",
            "valor": 3535672,
            "mensagem": "operação realizada com sucesso",
            "cpf": "411985860-01"
        }
    ],
    "success": [
        {
            "cod": "0",
            "valor": 3535672,
            "mensagem": "operação realizada com sucesso",
            "cpf": "411985860-01"
        }
    ],
    "error": null
}

Retorno em caso de Erro:

{
	"sucesso": "",
	"success": "",
	"error": [
		{
			"cod": "1",
			"valor": "669555010-70",
			"campo": "cpf",
			"mensagem": "cpf já cadastrado",
			"cpf": "669555010-70"
		}
	]
}

EnviarPessoaJuridica

Método responsável pelo cadastramento de novas pessoas jurídicas.

[POST] http://ip.do.cliente:porta/ws_rest/public/api/pessoajuridica

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Tipo	Obrigatório	Descrição
nome	texto (50)	Sim	Nome
cnpj	texto (20)	Sim	CNPJ
razao_social	texto (100)	Não	Razão Social
inscricao_estadual	texto (30)	Não	Inscrição Estadual
site	texto (50)	Não	Site
pgr	inteiro	Não	PGR
logradouro	texto (200)	Não	Descrição do Logradouro
cep	texto (8)	Não	CEP do Logradouro
numero	texto (50)	Não	Número do Logradouro
complemento	texto (100)	Não	Descrição do Complemento do Logradouro
bairro	texto (100)	Não	Descrição do Bairro do Logradouro
cidade	texto (100)	Não	Cidade da origem ou código do IBGE (conforme tabela padrão do IBGE)
sigla_estado	texto (2)	Não	Sigla do Estado do Logradouro
pais	texto (50)	Não	País

Requisição para envio dos dados

{
    "pessoajuridica": [
        {
            "nome": "EMPRESA",
            "cnpj": "13.046.058/0001-18",
            "razao_social": "EMPRESA",
            "inscricao_estadual": "EMPRESA",
            "site": "www.site.com",
            "pgr": 174,
            "logradouro": "ENDERECO",
            "cep": "89817000",
            "numero": "44",
            "complemento": "ENDERECO",
            "bairro": "ENDERECO",
            "cidade": "CHAPECO",
            "sigla_estado": "SC",
            "pais": "Brasil"
        }
    ]
}

Retorno em caso de Sucesso:

{
    "sucesso": [
        {
            "cod": "0",
            "valor": 3535677,
            "mensagem": "operação realizada com sucesso",
            "cnpj": "245492660001-56"
        }
    ],
    "success": [
        {
            "cod": "0",
            "valor": 3535677,
            "mensagem": "operação realizada com sucesso",
            "cnpj": "245492660001-56"
        }
    ],
    "error": null
}

Retorno em caso de Erro:

{
	"sucesso": "",
	"success": "",
	"error": [
		{
			"cod": "1",
			"valor": "245492660001-56",
			"campo": "cnpj",
			"mensagem": "cnpj já cadastrado",
			"cnpj": "245492660001-56"
		}
	]
}

EnviarCheckList

Método responsável pelo cadastramento de novos Checklists.

[POST] http://ip.do.cliente:porta/ws_rest/public/api/checklist

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Grupo	Tipo	Obrigatório	Descrição
ativo	0	String(1)	Não	Se o checklist estará ativo(S, N)
aprovado	0	String(1)	Não	Se o Checklist Estará aprovado(S, N)
env_email	0	String(1)	Não	Eviar dados por email(S, N)
placa	0	String(10)	Sim	Placa do veículo motor
terminal	0	Objeto	Sim	Dados do terminal
numero_terminal	1	String(10)	Sim	Número do terminal
versao_tecnologia	1	Inteiro	Sim	Versão da tecnologia
placa_carreta	0	String(10)	Não	Placa da carreta, enviar somente uma carreta
documento_proprietario	0	string(14)	Sim	Proprietário do veículo
documento_solicitante	0	string(14)	Não	Solicitante do checklist
cpf_motorista	0	String(11)	Não	Documento do motorista
cod_viagem	0	Integer	Não	Código da viagem
responsavel	0	String(100)	Não	Responśavel pelo Checklist
tipo_checklist	0	String(2)	Sim	RO: Rotina, PM: Pós Manutencao, PC: Pré Carregamento, TF: Teste de Frio
data_validade	0	Datetime(dd/mm/YYY H:i:s)	Sim	Data de validade do checklist
documento_transportador	0	String(14)	Sim	Documento do transportador
documento_embarcador	0	String(14)	Sim	Documento do embarcador
motivo_recusa	0	string(200)	Não	Motivo da recusa do checklist
acessorios	0	Array	Não	Lista de dados dos acessórios
codigo	1	Integer	Sim	Código do acessório
instalado	1	string(1)	Não	Instalado(S, N)
funcionando	1	string(1)	Não	Funcionando(S, N)
problema	1	string(50)	Não	Descrição do problema
perifericos	0	Array	Não	Lista de dados dos periféricos
codigo	1	Integer	Sim	Código do periférico
instalado	1	string(1)	Não	Instalado(S, N)
funcionando	1	string(1)	Não	Funcionando(S, N)
problema	1	string(50)	Não	Descrição do problema

Requisição para envio dos dados

{
    "ativo": "S",
    "aprovado": "S",
    "env_email": "N",
    "placa": "MOTOMASA",
    "terminal": {
        "numero_terminal": "268524507|252579",
        "versao_tecnologia": "6669"
    },
    "placa_carreta": "EVACARR",
    "documento_proprietario": "12387803000120",
    "documento_solicitante": "12387803000321"
    "cpf_motorista": "213388690-78",
    "tipo_checklist": "RO",
    "data_validade": "25/10/2023 16:30:00",
    "documento_transportador": "07836457000180",
    "documento_embarcador": "89126659000100",
    "acessorios": [
        {
            "codigo": "14",
            "instalado": "S",
            "funcionando": "S",
            "problema": "N"
        },
        {
            "codigo": "12",
            "instalado": "S",
            "funcionando": "S",
            "problema": "N"
        },
        {
            "codigo": "27",
            "instalado": "S",
            "funcionando": "S",
            "problema": "N"
        }
    ],
    "perifericos": [
        {
            "codigo": "81",
            "Instalado": "S",
            "funcionando": "S",
            "problema": "N"
        },
        {
            "codigo": "54",
            "Instalado": "S",
            "funcionando": "S",
            "problema": "N"
        },
        {
            "codigo": "74",
            "Instalado": "S",
            "funcionando": "S",
            "problema": "N"
        }
    ]
}

Retorno em caso de Sucesso:

{
    "success": [
        {
            "cod": "9",
            "valor": 3069,
            "campo": null,
            "mensagem": "CheckList cadastrado com sucesso!"
        }
    ],
    "error": []
}

Retorno em caso de Erro:

{
    "success": "",
    "error": [
        {
            "cod": "6",
            "campo": "placa",
            "mensagem": "Obrigatório envio do campo!",
            "mensagem_web": "Obrigatório envio do campo!"
        }
    ]
}

EnviarViagemPosicaoSentinel

Método responsável por receber um JSON no formato enviado pelo sistema Sentinel e realizar o cadastro de uma SM, posição e periféricos no Trafegus.

[POST] http://ip.do.cliente:porta/ws_rest/public/api/viagem/sentinel

Parâmetros a serem enviados:

Envio de Autenticação no cabeçalho HTTP / HTTPS.

Parâmetro	Nível	Tipo	Obrigatório	Descrição
shipmentId	0	integer	Sim	Código externo da viagem
address	0	array	Não	Endereço
full	1	string	Não	Utilizada para a descrição da tecnologia (Cadastro de Posições)
devices	0	array	Sim	Terminais/Rastreadores da viagem
imei	1	string	Não	Campo informativo para email de erro
latitude	1	float	Não	Latitude da posição do terminal (Cadastro de Posições)
longitude	1	float	Não	Longitude da posição do terminal (Cadastro de Posições)
type	1	string	Não	Campo informativo para email de erro
model	1	string	Sim	Versão de tecnologia do terminal
name	1	string	Sim	Para cadastro de terminal e veículo da viagem
placement	1	string	Não	Campo informativo para email de erro
batteryPercentage	1	integer	Não	Valor do sensor de bateria (Integração de Periféricos)
timestamp	1	string	Sim	Data de bordo do recebimento do sensor (Integração de Periféricos)
sensors	1	array	Não	Array de sensores
type	2	string	Não	Periférico padrão (utilizado para o de/para da Trafegus)
data	2	integer	Não	Valor do sensor (Integração de Periféricos)
units	2	string	Não	Utilizando quando type for "temperature" para identificar se é fahrenheit ou celsius
pickups	0	array	Sim	Locais do tipo Coleta
address	1	array	Sim	Endereços
title	2	string	Não	Campo utilizado para complementar o cadastro da referência
full	2	string	Sim	Descrição da referência (Cadastro de Viagem)
street	2	string	Não	Campo utilizado para complementar o cadastro da referência
city	2	string	Não	Campo utilizado para complementar o cadastro da referência
state	2	string	Não	Campo utilizado para complementar o cadastro da referência
zip	2	string	Não	Campo utilizado para complementar o cadastro da referência
country	2	string	Não	Campo utilizado para complementar o cadastro da referência
deliveries	0	array	Sim	Locais do tipo Entrega
address	1	array	Sim	Endereços
title	2	string	Não	Campo utilizado para complementar o cadastro da referência
full	2	string	Sim	Descrição da referência (Cadastro de Viagem)
street	2	string	Não	Campo utilizado para complementar o cadastro da referência
city	2	string	Não	Campo utilizado para complementar o cadastro da referência
state	2	string	Não	Campo utilizado para complementar o cadastro da referência
zip	2	string	Não	Campo utilizado para complementar o cadastro da referência
country	2	string	Não	Campo utilizado para complementar o cadastro da referência

Requisição para cadastro de SM, posição, periféricos

                    {
                        "shipmentId": 2976475,
                        "latitude": 22.32867,
                        "longitude": 114.1286,
                        "address": {
                            "full": "Container Terminal 8, Container Port Rd S, Hong Kong"
                        },
                        "devices": [
                            {
                                "imei": "72328622272622252",
                                "latitude": 36.009842,
                                "longitude": 120.777777,
                                "type": "gps",
                                "model": "MIX TELEMATICS",
                                "name": "koew",
                                "placement": "cargo",
                                "batteryPercentage": 100,
                                "timestamp": "2023-10-11T05:25:32.000+08:00",
                                "sensors": [
                                    {
                                        "type": "temperature",
                                        "data": 74.75,
                                        "units": "F"
                                    },
                                    {
                                        "type": "light",
                                        "data": 0.0,
                                        "units": "LUX",
                                        "value": "Dark"
                                    }
                                ]
                            },
                            {
                                "imei": "AC3636478",
                                "latitude": 36.01659,
                                "longitude": 120.666666,
                                "type": "gps",
                                "model": "MIX TELEMATICS",
                                "name": "ABC363",
                                "placement": "shipping_container",
                                "batteryPercentage": 91,
                                "timestamp": "2023-10-11T05:25:32.000+08:00",
                                "sensors": [
                                    {
                                        "type": "temperature",
                                        "data": 61.11,
                                        "units": "F"
                                    },
                                    {
                                        "type": "door",
                                        "data": "Open",
                                        "units": null,
                                        "value": null
                                    }
                                ]
                            },
                            {
                                "imei": "AA1234",
                                "latitude": 36.01659,
                                "longitude": 120.18229,
                                "type": "gps",
                                "model": "GSQ6C",
                                "name": "ABCQ36",
                                "placement": "shipping_container",
                                "batteryPercentage": 91,
                                "timestamp": "2023-10-11T05:25:32.000+08:00",
                                "sensors": [
                                    {
                                        "type": "temperature",
                                        "data": 61.11,
                                        "units": "F"
                                    },
                                    {
                                        "type": "light",
                                        "data": null,
                                        "units": null,
                                        "value": null
                                    }
                                ]
                            }
                        ],
                        "carrier": {
                            "name": "CMDU"
                        },
                        "pickups": [
                            {
                                "address": {
                                    "title": null,
                                    "full": "Weihai Shi, Shandong, China, 264300",
                                    "street": null,
                                    "city": "Weihai Shi",
                                    "state": "Shandong",
                                    "zip": "264300",
                                    "country": "China"
                                }
                            },
                            {
                                "address": {
                                    "title": null,
                                    "full": "Qingdao Shi, Shandong, China, 266555",
                                    "street": null,
                                    "city": "Qingdao Shi",
                                    "state": "Shandong",
                                    "zip": "266555",
                                    "country": "China"
                                }
                            },
                            {
                                "address": {
                                    "title": null,
                                    "full": "Rua Em lio Fiorentino Battistella, Itapoa, Santa Catarina, Brazil",
                                    "street": null,
                                    "city": "Itapoa",
                                    "state": "Santa Catarina",
                                    "zip": null,
                                    "country": "Brazil"
                                }
                            }
                        ],
                        "deliveries": [
                            {
                                "address": {
                                    "title": null,
                                    "full": "Qingdao Shi, Shandong, China, 266555",
                                    "street": null,
                                    "city": "Qingdao Shi",
                                    "state": "Shandong",
                                    "zip": "266555",
                                    "country": "China"
                                }
                            },
                            {
                                "address": {
                                    "title": null,
                                    "full": "Rua Em lio Fiorentino Battistella, Itapoa, Santa Catarina, Brazil",
                                    "street": null,
                                    "city": "Itapoa",
                                    "state": "Santa Catarina",
                                    "zip": null,
                                    "country": "Brazil"
                                }
                            },
                            {
                                "address": {
                                    "title": null,
                                    "full": "Rua araraquara 2, Sorocaba, Sao Paulo, Brazil",
                                    "street": null,
                                    "city": "Sorocaba",
                                    "state": "Sao Paulo",
                                    "zip": null,
                                    "country": "Brazil"
                                }
                            }
                        ]
                    }

Retorno em caso de Sucesso:

                    {
                        "Retorno": {
                            "codigo": "0",
                            "cod_viagem": 73862,
                            "erros": []
                        }
                    }

Exemplos de retorno em caso de erro:

Erro ao criar SM, cadastrar posição e periféricos:

                    {
                        "Retorno": [
                            {
                                "codigo": "3",
                                "erros": {
                                    "mensagem": "Erro ao criar a SM.",
                                    "retornoErroSM": {
                                        "sucesso": [],
                                        "success": [],
                                        "avisos": [],
                                        "error": [
                                            {
                                                "cod_status": "0",
                                                "valor": "2972494",
                                                "campo": "viag_codigo_externo",
                                                "cod_viagem_interno": 73862,
                                                "mensagem": "Já existe uma viagem com esse código externo!"
                                            },
                                            {
                                                "cod_status": "0",
                                                "valor": "2972494",
                                                "campo": "viag_codigo_externo",
                                                "cod_viagem_interno": 73862,
                                                "mensagem": "Já existe uma viagem com esse código externo!"
                                            }
                                        ]
                                    }
                                }
                            },
                            {
                                "codigo": "4",
                                "erros": [
                                    {
                                        "mensagem": "Erro ao salvar posições. Versão de tecnologia não encontrada. Verifique o campo [devices:model].",
                                        "imei": "1234567",
                                        "model": "MX TEL",
                                        "name": "koew",
                                        "placement": "cargo",
                                        "timestamp": "2023-10-11T05:25:32.000+08:00"
                                    }
                                ]
                            },
                            {
                                "codigo": "5",
                                "erros": [
                                    {
                                        "mensagem": "Erro ao salvar periféricos. Versão de tecnologia não encontrada. Verifique o campo [devices:model].",
                                        "imei": "1234567",
                                        "model": "MX TEL",
                                        "name": "koew",
                                        "placement": "cargo",
                                        "timestamp": "2023-10-11T05:25:32.000+08:00"
                                    }
                                ]
                            }
                        ]
                    }

Erro de pré cadastro de motorista e veículo antes da criação da SM:

                    {
                        "Retorno": {
                            "codigo": "1",
                            "erro": "O campo [devices:name] deve ser preenchido para realizar o cadastro de um veículo."
                        }
                    }

Erro de Campos Obrigatórios:

                    {
                        "Retorno": {
                            "codigo": "2",
                            "erro": "O campo [shipmentId] deve ser preenchido."
                        }
                    }

Erro de login:

                    {
                        "Retorno": {
                            "codigo": "-1",
                            "erro": "Usuario não encontrado na base de dados ou senha incorreta"
                        }
                    }

Código -1: Retorno de erro de login.

Código 0: Retorno de sucesso em relação a criação de SM.

Código 1: Retorno de erro no pré cadastro de motorista e veículo antes da criação da SM.

Código 2: Retorno de erro devido a falta de campos ou preenchido de forma incorreta.

Código 3: Retorno de erro na criação da SM.

Código 4: Retorno de erro no cadastro de posição de um ou mais terminais/rastreadores.

Código 5: Retorno de erro no cadastro de de um ou mais periféricos.

ConsultarPesquisa TrafegusCad

Retorna informações de Pesquisas(s)

Parâmetros a serem passados na consulta: <

Parâmetro	Obrigatório	Descrição
Tipo	Sim	Tipo de Objeto de Pesquisa (disponível na documentação no Tipo de Objeto de Pesquisa)
Documento	Sim	Documento do proprietário da pesquisa
Objeto	Sim	Objeto da pesquisa (Placa/CPF/CNPJ)

Exemplo para consultar os dados de Pesquisas

[GET] http://ip.do.cliente:porta/ws_rest/public/api/consulta?UltCodigo=1&Tipo=VC&Documento=48765269000195&Objeto=LUC0001

Retorno JSON

{
    "Pesquisas": [
        {
            "valido": "INVALIDA",
            "codigo_pesquisa": 2670,
            "data_validade": null,
            "data_consulta": "20/12/2018 17:44:42",
            "StatusDescricao": "OBJETO PERTENCE A BLACKLIST DA GERENCIADORA",
            "Status": "BL",
            "FornecedorPesquisa": "3",
            "FornecedorDescricao": "TRAFEGUS PESQUISA",
            "Objeto": "LUC0001",
            "TipoObjeto": "MO",
            "Documento": "48765269000195",
            "DocumentoNome": "TRANS GABRIEL"
        }
    ]
}

BuscaBaixaLocal

Retorna informações do(s) Baixa de Locais(s)

Parâmetros a serem passados na consulta:

Parâmetro	Obrigatório	Descrição
local	Não	Código do Local
viagem	Não	Código da Viagem

Exemplo para consultar os dados

[GET] http://ip.do.cliente:porta/ws_rest/public/api/baixalocal?UltCodigo=1

Retorno JSON

{
    "locais": [
        {
            "codigo_local": 73382,
            "descricao_local": "P. BONASSI - CHAPECO/SC",
            "data_cadastro_local": "2019-02-18 11:22:10",
            "codigo_viagem": 10083,
            "codigo_externo_local": null,
            "tipo_parada": "ORIGEM",
            "tipo_parada_codigo": 4,
            "eventos": [
                {
                    "codigo_evento": 7991,
                    "tipo_evento": "CHEGADA NO LOCAL",
                    "codigo_tipo_evento": 1,
                    "data_evento": null,
                    "data_cadastro_evento": "2019-02-18 11:32:22",
                    "sequencia": 1
                }
            ]
        },
        {
            "codigo_local": 73384,
            "descricao_local": "CORDILHEIRA ALTA-SC",
            "data_cadastro_local": "2019-02-18 11:22:10",
            "codigo_viagem": 10083,
            "codigo_externo_local": null,
            "tipo_parada": "COLETA",
            "tipo_parada_codigo": 2,
            "eventos": [
                {
                    "codigo_evento": 7992,
                    "tipo_evento": "CHEGADA NO LOCAL",
                    "codigo_tipo_evento": 1,
                    "data_evento": null,
                    "data_cadastro_evento": "2019-02-18 11:32:22",
                    "sequencia": 1
                }
            ]
        },
        {
            "codigo_local": 73386,
            "descricao_local": "P. XAXIM - XAXIM/SC",
            "data_cadastro_local": "2019-02-18 11:22:10",
            "codigo_viagem": 10083,
            "codigo_externo_local": null,
            "tipo_parada": "DESTINO",
            "tipo_parada_codigo": 5,
            "eventos": [
                {
                    "codigo_evento": 7993,
                    "tipo_evento": "CHEGADA NO LOCAL",
                    "codigo_tipo_evento": 1,
                    "data_evento": null,
                    "data_cadastro_evento": "2019-02-18 11:32:22",
                    "sequencia": 1
                }
            ]
        }
    ]
}

BuscaChecklist

Retorna informações do(s) Checklist(s)

Parâmetros a serem passados na consulta:

Parâmetro	Obrigatório	Descrição
UltCodigo	Sim	último código a ser enviado
Documento	Não	Documento do solicitante do checklist
DataCadastroI	Não	Data de cadastro inicial
DataCadastroF	Não	Data de cadastro final
veiculo	Não	Código do veículo
BuscarAlteracoes	Não	Ao invés de filtrar pelo código do checklist, filtra pelo código da alteração
IncluirDetalhes	Não	Retorna os itens do checklist e do terminal

Exemplo para consultar os dados

[GET] http://ip.do.cliente:porta/ws_rest/public/api/checklist

Retorno JSON

{
    "checklist": [
        {
            "codigo": 310,
            "event_id": 12824748,
            "data_validade": "06/11/2019 11:34:55",
            "data_cadastro": "06/11/2019 11:35:05",
            "data_fim": null,
            "aprovado": "SIM",
            "ativo": "SIM",
            "valido_viagem": "NAO",
            "nome_responsavel": null,
            "tipo": "ROTINA",
            "motivo_recusa": null,
            "usuario_adicionou": "ADMINISTRADOR",
            "usuario_alterou": "ADMINISTRADOR",
            "viagem_codigo": null,
            "veiculo_codigo": 3085079,
            "veiculo_placa": "ONX0001",
            "veiculo_cor": "PRETO",
            "veiculo_ano_modelo": "2019",
            "veiculo_renavam": "11111111111111111111111111111111111",
            "modelo_veiculo_descricao": "STRALISH",
            "carreta_codigo": null,
            "carreta_placa": null,
            "terminal_codigo": 182,
            "numero_terminal": "ONX0001",
            "versao_tecnologia": "ONIXSAT EQ.6 ONIXSMART 4.00",
            "motorista": "GILSON SANTOS PEREIRA",
            "proprietario": "TRANS SUPINO",
            "transportador": "TRANS SUPINO",
            "solicitante": "TRANS SUPINO",
            "documento_transportador": "54735256000176"
        }
    ]
}

BuscaSolicitacaoChecklist

Retorna informações de Solicitações de Checklist(s)

Parâmetros a serem passados na consulta:

Parâmetro	Obrigatório	Descrição
UltCodigo	Sim	Último código enviado
Documento	Sim	Documento do solicitante do checklist
DataCadastroI	Não	Data de cadastro inicial (Período a ser Filtrado)
DataCadastroF	Não	Data de cadastro final (Período a ser Filtrado)
CodVeiculo	Não	Código do Veículo

Exemplo para consultar os dados

[GET] http://ip.do.cliente:porta/ws_rest/public/api/solicitacaochecklist

Retorno JSON

{
    "solicitacao": [
        {
            "codigo": 310,
            "tipo": "ROTINA",
            "status": "FINALIZADA",
            "codigo_veiculo": 221,
            "placa_veiculo": "ABC0001",
            "codigo_carreta": 223,
            "placa_carreta": "XAZ0001",
            "codigo_terminal": 921,
            "terminal": "92101",
            "versao_tecnologia": "ONIXSAT EQ.1 - 1.00",
            "tecnologia": "ONIXSAT",
            "codigo_proprietario": 887,
            "proprietario": "TRANSPORTES BRASIL",
            "codigo_transportador": 887,
            "transportador": "TRANSPORTES BRASIL",
            "codigo_embarcador": null,
            "embarcador": null,
            "codigo_motorista": 928,
            "motorista": "MOTORISTA",
            "tipo_vinculo": "FIXO",
            "usuario_adicionou": "ADMINISTRADOR",
            "usuario_alterou": "ADMINISTRADOR",
            "data_cadastro": "06/05/2022 10:12:01",
            "observacao": "Observações da solicitação",
            "codigo_checklist": 331,
            "usuario_adicionou_checklist": "ADMINISTRADOR",
            "checklist_aprovado": "SIM",
            "data_cadastro_checklist": "06/05/2022 10:12:01"
        }
    ]
}

BuscaRegistrosSistema

Retorna informações de Registros do Sistema

Filtros de consulta:

Parâmetro	Obrigatório	Descrição
sessao	Não	Código da Sessão
chave	Não	Código da chave
limit	Não	Quantidade máxima de registros a serem listados
offset	Não	Deslocamento de registros a partir do primeiro

Exemplo para consultar os dados

[GET] http://ip.do.cliente:porta/ws_rest/public/api/sistemaregistro

Retorno JSON

{
    "success": [
        {
            "sreg_sessao": "TRAFEGUS_WEB",
            "sreg_chave": "TEMPO_ATT_FROTA",
            "sreg_valor": "1",
            "sreg_data_cadastro": null
        }
    ],
    "error": []
}

BuscarTemperatura

Retorna informações de temperatura

Obrigatório adicionar o parâmetro UltCodigo (cada requisição busca 100 registros com os próximos dados a partir do código informado).

Obrigatório adicionar o parâmetro Documento (CPF ou CNPJ do transportador ou embarcador):

Síntaxe do Comando:

[GET] http://ip_do_cliente:porta/ws_rest/public/api/temperatura?UltCodigo=código_sequencial&Documento=cpf_ou_cnpj>

Exemplo:

[GET] http://894.576.178.987:0761/ws_rest/public/api/temperatura?UltCodigo=1&Documento=53106183000190

Retorno JSON

{
    "temperatura": [
        {
            "codigo": 1,
            "proximidade": "0,563 KM DE CRISTO REI ALIM LTDA",
            "latitude": "-27.1231872169",
            "longitude": "-52.6272824969",
            "numero_terminal": "KADU7777",
            "placa": "ABC1234",
            "versao_tecnologia": "ONIXSAT EQ.6 ONIXSMART 4.00",
            "sensor": "SENSOR DE TEMPERATURA 01",
            "valor_temperatura": "50",
            "data_computador_bordo": "25/08/2020 00:14:54",
            "data_tecnologia": "25/08/2020 00:14:54"
        },
        {
            "codigo": 2,
            "proximidade": "0,563 KM DE CRISTO REI ALIM LTDA",
            "latitude": "-27.1231872169",
            "longitude": "-52.6272824969",
            "numero_terminal": "KADU7777",
            "placa": "ABC1234",
            "versao_tecnologia": "ONIXSAT EQ.6 ONIXSMART 4.00",
            "sensor": "SENSOR DE TEMPERATURA 02",
            "valor_temperatura": "9",
            "data_computador_bordo": "25/08/2020 00:14:54",
            "data_tecnologia": "25/08/2020 00:14:54"
        }
    ]
}

BuscarTemperaturaResumido

Retorna informações de temperatura resumido

Obrigatório adicionar o parâmetro UltCodigo (cada requisição busca 5000 registros com os próximos dados a partir do código informado) Obrigatório adicionar o parâmetro Documento (CPF ou CNPJ do transportador ou embarcador)
Opcional o parâmetro TipoOperacao

Síntaxe do Comando:

[GET] http://ip_do_cliente:porta/ws_rest/public/api/temperaturaresumido?UltCodigo=código_sequencial&Documento=cpf_ou_cnpj&TipoOperacao=tipo_operacao

Exemplo:

[GET] http://894.576.178.987:0761/ws_rest/public/api/temperaturaresumido?UltCodigo=1&Documento=53106183000190&TipoOperacao=SECA

Retorno JSON

{
    "temperatura": [
        {
            "codigo": 1115253773,
            "latitude": "-18.2929328000",
            "longitude": "-51.1531232000",
            "placa": "DDN3A65",
            "versao_tecnologia": "SASCAR SASCARGA",
            "valor_temperatura": "26",
            "data_computador_bordo": "12/07/2023 00:00:04",
            "tope_descricao": null,
            "status_bau_01": "0",
            "data_hora_status_bau_01": "12/07/2023 00:00:04"
        },
        {
            "codigo": 1115253773,
            "latitude": "-18.2929328000",
            "longitude": "-51.1531232000",
            "placa": "DDN3A65",
            "versao_tecnologia": "SASCAR SASCARGA",
            "valor_temperatura": "26",
            "data_computador_bordo": "12/07/2023 00:00:04",
            "tope_descricao": null,
            "status_bau_01": "0",
            "data_hora_status_bau_01": "12/07/2023 00:00:04"
        },
        {
            "codigo": 1115253773,
            "latitude": "-18.2929328000",
            "longitude": "-51.1531232000",
            "placa": "DDN3A65",
            "versao_tecnologia": "SASCAR SASCARGA",
            "valor_temperatura": "26",
            "data_computador_bordo": "12/07/2023 00:00:04",
            "tope_descricao": "CAMARA FRIA",
            "status_bau_01": "0",
            "data_hora_status_bau_01": "12/07/2023 00:00:04"
        },
        {
            "codigo": 1115253773,
            "latitude": "-18.2929328000",
            "longitude": "-51.1531232000",
            "placa": "DDN3A65",
            "versao_tecnologia": "SASCAR SASCARGA",
            "valor_temperatura": "26",
            "data_computador_bordo": "12/07/2023 00:00:04",
            "tope_descricao": null,
            "status_bau_01": "0",
            "data_hora_status_bau_01": "12/07/2023 00:00:04"
        },
    ]
}

BuscarMacrosMensagens

Busca as macros e mensagens livres enviadas pelo terminal para a central

Filtros de consulta:

Parâmetro	Obrigatório	Descrição
numero_terminal	Sim¹	Número do terminal de origem
versao_tecnologia	Sim²	Código da versão da tecnologia do terminal de origem
tecnologia	Sim²	Nome da tecnologia do terminal de origem
terminais	Sim¹	Array para filtro por múltiplos terminais e tecnologias, no formato [["numero_terminal_1", "tecnologia_1"], ["numero_terminal_2", "tecnologia_2"], ["numero_terminal_n", "tecnologia_n"]]
documento_proprietario	Sim³	Se informado, apenas serão retornadas as macros enviadas por veículos cujo proprietário corresponda ao documento fornecido (o documento pode ser tanto CPF quanto CNPJ)
texto	Não	Se esse parâmetro for informado, irá retornar macros que possuem o seu texto igual ao filtrado (considera o valor do campo texto e não considera o campo descrição)
data_ultima_posicao	Não	Se esse parâmetro for informado, só serão retornadas macros enviadas após essa data (no formato yyyy-mm-dd hh:mm-ss)
codigo_ultima_posicao	Não	Se for informado, só serão retornadas macros enviadas após a macro com esse código
tipo_informacao	Não	Se informado, apenas serão retornadas as mensagens do tipo especificado no filtro (MACRO ou MENSAGEM). Caso o filtro não seja informado, serão retornadas informações de ambos os tipos: MACRO e MENSAGEM
placa	Não	Se informado, apenas serão retornadas as mensagens enviadas pelo veículo correspondente à placa informada no filtro.
limit	Não	Quantidade máxima de registros retornados
offset	Não	Registro inicial que será retornado

¹ - Obrigatório informar a lista de terminais e tecnologias ou o número do terminal
² - Obrigatório informar o nome da tecnologia ou o código da versão da tecnologia, caso não seja informado o array de terminais
³ - Obrigatório informar o documento do proprietário, caso o array de terminais, o nome da tecnologia ou o código da versão da tecnologia não sejam informados

Exemplo de requisição

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/macro?numero_terminal=12345&versao_tecnologia=36&limit=100

Resposta

Um lista de objetos no formato

número: Número da macro
texto: Texto da macro
data_computador_bordo: Data de envio da macro no formato yyyy-mm-dd hh:mm:ss
latitude: Latitude da macro (em formato decimal)
longitude: Longitude da macro (em formato decimal)
descricao: Descrição da macro
mascara: Máscara da macro
numero_terminal: Número do terminal de origem
versao_tecnologia: Versão da tecnologia do terminal de origem
tecnologia: Nome da tecnologia do terminal de origem
localizacao: Descrição da localização ou proximidade do momento de envio da mensagem ou macro
placa: Descrição da placa do veículo associado ao rastreador de envio da macro/mensagem
frota: Descrição da frota do cadastro do veículo associado ao rastreador de envio da macro/mensagem
hodometro: Hodômetro de acordo com o último recebimento de posição do rastreador
motorista: Nome do motorista associado ao envio da mensagem
cpf_motorista: CPF do motorista associado ao envio da mensagem

Retorno JSON

{
    "success": [
        {
            "numero": "CPF_01",
            "texto": "INICIO DE JORNADA|",
            "data_computador_bordo": "2020-09-10 10:25:42",
            "latitude": "-26.9775586494",
            "longitude": "-52.5882482529",
            "descricao": "INICIO DE JORNADA",
            "mascara": "",
            "numero_terminal": "TESTE",
            "versao_tecnologia": 36,
            "tecnologia": "TELEMONITORADOS,
            "localizacao": "0,029 KM DE CHAPECO SC",
            "placa": "ABC1234",
            "frota": "FROTA 01",
            "hodometro": "123456",
            "motorista": "MOTORISTA 01",
            "cpf_motorista": "674218780-83"
        },
        {
            "numero": "CPF_01",
            "texto": "INICIO DE JORNADA|",
            "data_computador_bordo": "2020-09-10 11:02:04",
            "latitude": "-26.9775586494",
            "longitude": "-52.5882482529",
            "descricao": "INICIO DE JORNADA",
            "mascara": "",
            "numero_terminal": "TESTE",
            "versao_tecnologia": 36,
            "tecnologia": "TELEMONITORADOS,
            "localizacao": "0,029 KM DE CHAPECO SC",
            "placa": "ABC1234",
            "frota": "FROTA 01",
            "hodometro": "123456",
            "motorista": "MOTORISTA 01",
            "cpf_motorista": "674218780-83"
        }
    ]
}

BuscarStatusPedagio

Retorna informações de status de pedágio

Filtros de consulta:

Parâmetro	Obrigatório	Descrição
CodViag	Sim (se não for informado CodViagExterno)	Código da viagem
CodViagExterno	Sim (se não for informado CodViag)	Código externo da viagem

Exemplo para consultar os dados

[GET] http://ip.do.cliente:porta/ws_rest/public/api/statusPedagio?CodViag=123

Retorno JSON

{
    "success": {
        "status_legivel": "Enviado Tecnologia",
        "status": "ET",
        "retorno_tecnologia": "Veículo não disponível",
        "valor": "357.36",
        "sequencia": 2,
        "conta_tecnologia": "MOVEMAIS",
        "codigo_viagem": 14356,
        "codigo_motorista": 3086547,
        "codigo_veiculo": 3085281,
        "codigo_empresa_solicitante": 11251,
        "protocolo": "33672394",
        "data_cadastro": "2020-09-16 17:34:41.511883"
    },
    "sucesso": {
        "status_legivel": "Enviado Tecnologia",
        "status": "ET",
        "retorno_tecnologia": "Veículo não disponível",
        "valor": "357.36",
        "sequencia": 2,
        "conta_tecnologia": "MOVEMAIS",
        "codigo_viagem": 14356,
        "codigo_motorista": 3086547,
        "codigo_veiculo": 3085281,
        "codigo_empresa_solicitante": 11251,
        "protocolo": "33672394",
        "data_cadastro": "2020-09-16 17:34:41.511883"
    },
    "error": []
}

BuscarReferencia

Retorna informações de referência

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/referencia/consultar

Filtros de consulta:

Parâmetro	Obrigatório	Descrição
descricao (Mínimo 3 caracteres)	Não	Parte da descrição da referência a retornar
dataAlteracao	Não	Se esse parâmetro for informado, só serão retornadas referencias alteradas após essa data (no formato yyyy-mm-dd hh:mm-ss)
codClasseReferencia	Não	Código da classe das referências a retornar
limit	Não	Quantidade máxima de registros retornados

Retorno JSON

{
    "success": [
        {
            "refe_codigo": 411015,
            "refe_descricao": "REFERENCIA 1",
            "refe_latitude": "-21.5613911196",
            "refe_longitude": "-45.4563617706",
            "refe_cref_codigo": 25,
            "refe_cida_codigo": 4089,
            "refe_pess_oras_codigo_local": null,
            "refe_raio": "500.00000",
            "refe_km": null,
            "refe_bandeira": null,
            "refe_utilizado_sistema": "N",
            "refe_data_cadastro": "2018-11-08 11:21:27",
            "refe_importado": "N",
            "refe_pess_oras_codigo_dono": 0,
            "refe_usuario_adicionou": "TRAFEGUS",
            "refe_usuario_alterou": "TRAFEGUS",
            "refe_codigo_gr": null,
            "refe_ref_temporaria": "N",
            "refe_ponto_geografico": "0101000020E6100000A33B889D29BA46C031CD74AF938E35C0",
            "refe_viag_codigo": null,
            "refe_term_numero_terminal01": null,
            "refe_term_numero_terminal02": null,
            "refe_term_numero_terminal03": null,
            "refe_data_alteracao": null
        },
        {
            "refe_codigo": 423801,
            "refe_descricao": "REFERENCIA 2",
            "refe_latitude": "-16.0797460000",
            "refe_longitude": "-47.9876660000",
            "refe_cref_codigo": 25,
            "refe_cida_codigo": 2377,
            "refe_pess_oras_codigo_local": null,
            "refe_raio": "500.00000",
            "refe_km": null,
            "refe_bandeira": null,
            "refe_utilizado_sistema": "N",
            "refe_data_cadastro": "2019-05-16 16:59:39",
            "refe_importado": "N",
            "refe_pess_oras_codigo_dono": 3086696,
            "refe_usuario_adicionou": "TRAFEGUS",
            "refe_usuario_alterou": "TRAFEGUS",
            "refe_codigo_gr": null,
            "refe_ref_temporaria": "N",
            "refe_ponto_geografico": "0101000020E610000081AFE8D66BFE47C0A0FCDD3B6A1430C0",
            "refe_viag_codigo": null,
            "refe_term_numero_terminal01": null,
            "refe_term_numero_terminal02": null,
            "refe_term_numero_terminal03": null,
            "refe_data_alteracao": "2020-07-17 17:22:32"
        },
    ]
}

BuscarContaTecnologia

Retorna contas de tecnologia

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/conta_tecnologia

Retorno JSON

{
    "conta_tecnologia": [
        {
            "codigo": 3,
            "conta_tecnologia": "TELEMONITORADOS",
            "codigo_tecnologia": 20,
            "tecnologia": "TELEMONITORADOS"
        },
        {
            "codigo": 4,
            "conta_tecnologia": "AUTOTRAC",
            "codigo_tecnologia": 8,
            "tecnologia": "AUTOTRAC_ADE"
        },
        {
            "codigo": 5,
            "conta_tecnologia": "ONX0003",
            "codigo_tecnologia": 1,
            "tecnologia": "ONIXSAT"
        },
        {
            "codigo": 6,
            "conta_tecnologia": "CHECKROTA",
            "codigo_tecnologia": 28,
            "tecnologia": "CHECKROTA"
        },
        {
            "codigo": 7,
            "conta_tecnologia": "SITRACK",
            "codigo_tecnologia": 22,
            "tecnologia": "SITRACK"
        },
        {
            "codigo": 8,
            "conta_tecnologia": "INTEGRACAO SASCAR",
            "codigo_tecnologia": 4,
            "tecnologia": "SASCAR"
        }
    ]
}

BuscarPerfil

Retorna perfis de usuário

Filtros de consulta:

Parâmetro	Obrigatório	Descrição
descricao	Não	Descrição do perfil

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/perfil

Exemplo com filtro por descrição

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/perfil?descricao=WEB

Retorno JSON

{
    "success": {
        "perfil": [
        {
            "codigo": 1,
            "descricao": "WEB"
        },
        {
            "codigo": 2,
            "descricao": "PRESTADOR"
        }
    }
}

BuscarQuilometragemVeiculos

Retorna a quilometragem dos veículos

Filtros de consulta:

Parâmetro	Obrigatório	Descrição
dataInicio	Sim	Data de início da consulta
dataFim	Sim	Data de fim da consulta
placa	Não	Opcional, podendo filtrar por uma parte da placa
numeroTerminal	Não	Opcional, podendo filtrar por uma parte do número do terminal
frota	Não	Opcional, podendo filtrar por uma parte da frota
proprietario	Não	Opcional, podendo filtrar por uma parte do nome do proprietario
numeroManifesto	Não	Opcional, podendo filtrar por uma parte do número
viagem	Não	Opcional, passando um código específico de viagem
agruparPorViagem	Não	(0 ou 1) - indicando se deverão ser exibidas as informações das viagens agrupadas como detalhe de cada veículo

Exemplo com os filtros obrigatórios:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/quilometragemVeiculo?dataInicio=24/02/2022 23:55&dataFim=24/02/2022 23:59:11

Retorno JSON

            {
                "success": {
                  "quilometragemVeiculos": [
                    {
                      "placa": "ONX0001",
                      "frota": null,
                      "tipoVeiculo": "CAVALO",
                      "terminal": "TELEONX0001",
                      "kmSemViagem": 0,
                      "kmComViagem": 0,
                      "kmTotal": 0,
                      "proprietario": "TRANSPORTADORA TRAFEGUS"
                    },
                    {
                      "placa": "BYD4768",
                      "frota": null,
                      "tipoVeiculo": "CAVALO",
                      "terminal": "BYD4768",
                      "kmSemViagem": 0,
                      "kmComViagem": 0,
                      "kmTotal": 0,
                      "proprietario": "RODRIGO OTAVIO BORTOLON ARCAS"
                    }
                }
            }

BuscarViagemResumida

Retorna os dados de viagens mais simplificado

Para consultar um pacote de viagens adicione o último código recebido UltCodigo(cada requisição busca 100 registros com os próximos dados a partir do código informado):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?UltCodigo=123456

Para consultar um pacote de viagens específico, adicione os códigos de viagem no padrão "Codigo_Viagem,Codigo_Viagem[,...]" (limitado em 100 registros):

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?Viagens=123456,123457,123458

Para consultar as viagens realizadas por um Motorista, adicione o número do CPF do motorista no parâmetro MotoristaCPF somente com digitos:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?MotoristaCPF=12345678900

Para consultar as viagens realizadas por um Veículo, adicione a placa no parâmetro Placa somente com digitos:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?Placa=AAA0000

Para consultar as viagens realizadas por uma Frota, adicione o identificador da Frota no parâmetro Frota:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?Frota=AAA0000

Para consultar as viagens realizadas por um Transportador, adicione o número do documento (CNPJ ou CPF) do transportador no parâmetro TranspordadorDoc somente com digitos:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?TranspordadorDoc=12345678900

Para consultar as viagens realizadas por um Embarcador, adicione o número documento (CNPJ) do embarcador no parâmetro EmbarcadorDoc somente com digitos:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?EmbarcadorDoc=12345678912345

Para consultar as viagens finalizadas em uma data adicionar o valor do dia desejado no parâmetro DataFinalizacao:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?DataFinalizacao=10/09/2018

Para consultar as viagens Iniciadas entre um período de datas, será necessário informar os valores nos parâmetros DataInicioI (data de início da busca) e DataInicioF (data de fim da busca)

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?DataInicioI=09/10/2018&DataInicioF=10/10/2018

Para consultar as viagens Iniciadas em uma Data, será necessário informar os valores nos parâmetros DataEfetivacao

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?DataEfetivacao=09/10/2018

Para consultar as viagens Finalizadas em uma Data, será necessário informar os valores nos parâmetros DataFinalizacaoI (data de início da busca) e DataFinalizacaoF (data de fim da busca)

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?DataFinalizacaoI=09/10/2018&DataFinalizacaoF=10/10/2018

Para consultar as viagens a partir de uma determinada data de alteração, será necessário informar o valor no parâmetro dataAlteracao

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?dataAlteracao=10/09/2018 11:45:00

Para fazer a ordenação da consulta ser pela data de alteração, enviar a flag OrdenarDataAlteracao. Caso contrário, a ordenação padrão é pelo código da viagem

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?OrdenarDataAlteracao=true

Para retornar apenas a última viagem, ordenado pelo seu código, de maneira decrescente.

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/viagemsimplificado?UltCodigo=1&UltimaViagem=true

Retorno JSON

            {
                    "viagens": [
                        {
                            "veiculos": [
                                {
                                    "placa": "CAV0001",
                                    "nro_liberacao": null,
                                    "escolta": null
                                },
                                {
                                    "placa": "CAR0002",
                                    "nro_liberacao": null,
                                    "escolta": null
                                }
                            ],
                            "motoristas": [
                                {
                                    "cpf_moto": "786135853-45"
                                }
                            ],
                            "origem": {
                                "vloc_descricao": "SHOPPING PATIO CHAPECO",
                                "refe_latitude": "-27.0707338178",
                                "refe_longitude": "-52.6269900798",
                                "conhecimentos": [
                                    {
                                        "vlco_cpf_cnpj": "518912606-42"
                                    },
                                    {
                                        "vlco_cpf_cnpj": "518912606-42"
                                    }
                                ]
                            },
                            "destino": {
                                "descricao": "FLORIANOPOLIS-SC",
                                "refe_latitude": "-27.5963000000",
                                "refe_longitude": "-48.5491000000",
                                "conhecimentos": [
                                    {
                                        "vlco_cpf_cnpj": "518912606-42"
                                    }
                                ]
                            },
                            "locais": [
                                {
                                    "sequencia_parada": 2,
                                    "tipo_parada": "ENTREGA",
                                    "vloc_descricao": "P. LIGEIRINHO - PONTE SERRADA/SC",
                                    "refe_latitude": "-26.8555555556",
                                    "refe_longitude": "-52.0316666667",
                                    "conhecimentos": [
                                        {
                                            "vlco_cpf_cnpj": "54735256000176"
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }

BuscarKmRodado

Retorna informações dos KMs rodados pelo veículo

Filtros de consulta:

Parâmetro	Obrigatório	Descrição
DataInicio	Sim	Data de Início do Período de Rodagem, no formato DD/MM/YYYY H:i:s
DataFim	Sim	Data de Fim do Período de Rodagem, no formato DD/MM/YYYY H:i:s
TipoIdentificador	Sim	1=Placa, 2=CPF
CNPJ	Não	(CNPJ do Transportador) - obrigatório se não informado Placa ou CPF
Identificador	Não	(Placa ou CPF do objeto)- obrigatório se não informado CNPJ do Transportador

Exemplos de chamada do método:

Filtrando por Identificador:
http://ip.do.cliente:porta/ws_rest/public/api/buscarkmrodado?DataInicio=01/05/2022 00:00:00&DataFim=12/05/2022 00:00:00&TipoIdentificador=1&Identificador=AAA1234

Filtrando por CNPJ:
http://ip.do.cliente:porta/ws_rest/public/api/buscarkmrodado?DataInicio=01/05/2022 00:00:00&DataFim=12/05/2022 00:00:00&CNPJ=26107172000152

Retorno Sucesso JSON

            {
                "sucesso": [
                    {
                        "km_total": "47.74",
                        "km_em_viagem": "21.32",
                        "km_sem_viagem": "26.42",
                        "placa": "KADU7777",
                        "nome_motorista": "",
                        "cpf": "",
                        "cod_status": "0",
                        "mensagem": "sucesso"
                    },
                    {
                        "km_total": "0.00",
                        "km_em_viagem": "0.00",
                        "km_sem_viagem": "0.00",
                        "placa": "TESTEEE02",
                        "nome_motorista": "",
                        "cpf": "",
                        "cod_status": "0",
                        "mensagem": "sucesso"
                    },
                    {
                        "km_total": "96.40",
                        "km_em_viagem": "94.66",
                        "km_sem_viagem": "1.74",
                        "placa": "AAA0003",
                        "nome_motorista": "",
                        "cpf": "",
                        "cod_status": "0",
                        "mensagem": "sucesso"
                    },
                    {
                        "km_total": "16.30",
                        "km_em_viagem": "16.30",
                        "km_sem_viagem": "0.00",
                        "placa": "BOG1S00",
                        "nome_motorista": "",
                        "cpf": "",
                        "cod_status": "0",
                        "mensagem": "sucesso"
                    },
                    {
                        "km_total": "0.00",
                        "km_em_viagem": "0.00",
                        "km_sem_viagem": "0.00",
                        "placa": "KLGTESTE13",
                        "nome_motorista": "",
                        "cpf": "",
                        "cod_status": "0",
                        "mensagem": "sucesso"
                    },
                    {
                        "km_total": "1.38",
                        "km_em_viagem": "0.00",
                        "km_sem_viagem": "0.00",
                        "placa": "SOAP666",
                        "nome_motorista": "",
                        "cpf": "",
                        "cod_status": "0",
                        "mensagem": "sucesso"
                    },
                    {
                        "km_total": "17.58",
                        "km_em_viagem": "17.58",
                        "km_sem_viagem": "0.00",
                        "placa": "WIL5555",
                        "nome_motorista": "",
                        "cpf": "",
                        "cod_status": "0",
                        "mensagem": "sucesso"
                    }
                ],
                "avisos": [],
                "erro": []
            }

Retorno Erro JSON

            {
                "sucesso": [],
                "avisos": [],
                "erro": {
                    "cod_status": "",
                    "mensagem": {
                        "TipoIdentificador": {
                            "isEmpty": "O valor é obrigatório e não pode estar vazio"
                        },
                        "DataInicio": {
                            "isEmpty": "O valor é obrigatório e não pode estar vazio"
                        },
                        "DataFim": {
                            "isEmpty": "O valor é obrigatório e não pode estar vazio"
                        },
                        "CNPJ": {
                            "isEmpty": "O valor é obrigatório e não pode estar vazio"
                        },
                        "Identificador": {
                            "isEmpty": "O valor é obrigatório e não pode estar vazio"
                        }
                    }
                }
            }

            {
                "sucesso": [],
                "avisos": [],
                "erro": {
                    "cod_status": "1",
                    "mensagem": "O período máximo de filtro são 31 dias"
                }
            }

BuscarConfiguracaoSistema

Retorna configurações do sistema, referente à recuperação de senha via SMS

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/configuracaosistema

Retorno JSON

{
    "configuracao_sistema":
        {
            "habilitar_config_sms": true,
            "link_api_sms": "https://www.linkteste.com.br",
            "chipeira_sms": "1234567890",
            "canal_sms": "1234567890",
            "token_sms": "1234567890"
        }
}

BuscarPrevisaoRecalculadaProxPonto

Retorna a previsão de chegada do próximo local recalculada, baseado no código da viagem passado por parâmetro. Atualmente retornar a mesma informação exibida no Monitor Logístico, no campo "Prev. Próximo Local Recalculada".

Para consultar a previsão de uma viagem, adicione o código da viagem na url:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/previsaoRecalculadaProxPonto/123456

Observação: Quando a viagem estiver finalizada, o campo "previsao_prox_local_recalculada" será null.

Retorno Sucesso JSON

                {
                    "success": {
                        "previsao_prox_local_recalculada": "2023-04-06 11:11:22"
                    },
                    "error": null
                }

Retorno Erro JSON

                {
                    "success": null,
                    "error": "Example - Error Processing Request"
                }

BuscarTerminais

Retorna uma lista de terminais de acordo com os filtros utilizados na requisição.

Para realizar a consultar de terminais, basta consultar a url:

Ex1: [GET] http://ip.do.cliente:porta/ws_rest/public/api/terminais

Ou utilizar os parâmetros de sua escolha na url:

Ex2: [GET] http://ip.do.cliente:porta/ws_rest/public/api/terminais?ultCodigo=1360&descricao_tecnologia=descExemplo&ativo=s&codigo=100524&numero=ABC123&codigo_versao=6724&codigo_tecnologia=1

Parâmetro	Obrigatório	Descrição
ultCodigo	Não	Último código retornado, para consultar deste código para frente. Requisição está limitada a 1000 registros de retorno.
codigo	Não	Código do terminal na base Trafegus.
numero	Não	Número do terminal na base Trafegus.
codigo_versao	Não	Código da versão da tecnologia na base Trafegus.
codigo_tecnologia	Não	Código da tecnologia na base Trafegus.
descricao_tecnologia	Não	Descrição da tecnologia na base Trafegus, a busca será realizada de forma que a descrição da tecnologia contenha a descrição informada no parâmetro, sem considerar letras maiusculas ou minusculas.
ativo	Não	Status do terminal na base Trafegus. Aceita "S" ou "N" sem considerar maiuscula ou minuscula.

Retorno Sucesso JSON

[
    {
        "codigo": 123456,
        "numero": "ABC123456",
        "codigo_versao": 6724,
        "ativo": "S",
        "codigo_tecnologia": 15,
        "descricao_tecnologia": "DESCRICAO_1"
    },
    {
        "codigo": 456789,
        "numero": "DEF456789",
        "codigo_versao": 6724,
        "ativo": "N",
        "codigo_tecnologia": 16,
        "descricao_tecnologia": "DESCRICAO_2"
    }
]

BuscarPessoaFisica

Retorna informações de uma pessoa física específica através do CPF.

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/pessoafisica/12345678911

Retorno JSON

{
	"pessoafisica": {
		"codigo": 3535618,
		"status": "Ativo",
		"cpf": "12345678911",
		"nome": "PFIS",
		"matricula": "123",
		"data_nascimento": "30\/11\/1998",
		"nome_mae": "MAE",
		"nome_pai": "PAI",
		"rg": "20121033950",
		"data_emissao_rg": "30\/11\/2000",
		"emissor_rg": "SSP",
		"estado_emissor_rg": "SC",
		"estado_civil": "S",
		"logradouro": "END",
		"numero_pis": "4387902408",
		"cep": "89817000",
		"numero": "44",
		"complemento": "END",
		"bairro": "END",
		"cidade": "CHAPECO",
		"naturalidade_descricao_ibge": "ITAPIRANGA",
		"naturalidade_uf_sigla": "SC",
		"sigla_estado": "SC",
		"pais": "BRASIL",
		"profissao": "MOTORISTA",
		"contatos": [
			{
				"codigo": 8356,
				"texto": "CONTATO",
				"fone1": "49999999999",
				"fone2": "49999999999",
				"fone3": "49999999999",
				"celular": "49999999999",
				"email": ""email@email.com"
			}
		],
		"transportadores": [
			{
				"documento_transportador": "84447052000109",
				"vinculo_contratual": 1
			}
		],
		"embarcadores": [
			{
				"documento_embarcador": "35261222000142",
				"vinculo_contratual": 1
			}
		]
	}
}

BuscarPessoaJuridica

Retorna informações de uma pessoa jurídica específica através do CNPJ.

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/pessoajuridica/13046058000118

Obs: O CNPJ deve ser enviado sem pontuação

Retorno JSON

{
    "pessoajuridica": {
        "codigo": 3535641,
        "cnpj": "13.046.058\/0001-18",
        "razao_social": "EMPRESA",
        "inscricao_estadual": "43432432",
        "site": "WWW.SITE.COM",
        "nome": "EMPRESA",
        "logradouro": "END",
        "cep": "89817000",
        "complemento": "END",
        "bairro": "END",
        "cidade": "CHAPECO",
        "sigla_estado": "SC",
        "pais": "BRASIL",
        "pgr": 174
    }
}

BuscarDadosPernoite

Retorna informações de pernoite do motorista.

Parâmetro	Obrigatório	Descrição
data_inicio	SIM	Data início ponto motorista.
data_fim	SIM	Data fim ponto motorista.
cpf_motorista	NÃO	CPF do motorista.
doc_transportador	NÃO	CPF/CNPJ do transportador.
placa	NÃO	Placa do veículo.

Para consultar um motorista específico, adicione o CPF do motorista na URL:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/BuscarDadosPernoite?cpf_motorista=00000000000

Para consultar um veículo específico, adicione a placa do veículo na URL:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/BuscarDadosPernoite?placa=MTG1234

Para consultar um transportador específico, adicione o documento do transportador na URL:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/BuscarDadosPernoite?doc_transportador=00000000000100

Retorno JSON

                            {
                                "motorista": "FULANO DE TAL",
                                "cpf": "123.456.789-10",
                                "transportador": "TRANSPORTES VALIDACAO",
                                "doc_transportador": "12.123.123\/1234-12",
                                "data_inicial": "01\/07\/2024 00:00:00",
                                "data_final": "30\/07\/2024 00:00:00",
                                "pernoites": [
                                    {
                                        "data_inicio": "27\/07\/2024 17:06:56",
                                        "data_fim": "27\/07\/2024 17:07:49",
                                        "tempo": "00:00:53"
                                    }
                                ]
                            }

Buscar Dados Nota Fiscal Concreserv

Retorna os dados de uma nota fiscal, os dados retornados são provenientes de uma API externa.

A busca é somente referente a uma nota fiscal, informando a chave da nota:

Ex: [GET] http://ip.do.cliente:porta/ws_rest/public/api/consultadadosnf/123456

Retorno JSON de sucesso

                            {
                                "success": {
                                    "nota_fiscal": {
                                        "numero": "123456",
                                        "remetente": "BRASAO AVENIDA",
                                        "enderecoremetente": "CHAPECÓ",
                                        "destinatario": "ATLETICA NORTE",
                                        "enderecodestinatario": "CHAPECÓ",
                                        "valor": "1000.00",
                                        "produto": "TESTE",
                                        "peso": "10",
                                        "especie": "TESTE",
                                        "quantidade": "1"
                                    }
                                },
                                "error": []
                            }

Retornos em caso de erro ou nota não encontrada

                            {
                                "success": [],
                                "error": []
                            }

Tipo de Local

Tipo de local para associar ao transportador, usado no parâmetro tipo_local

Parâmetros a serem enviados

Código	Descrição
1	AREA DE RISCO
2	PONTO PERMITIDO
3	PONTO PROIBIDO
4	ORIGEM
5	DESTINO
6	ENTREGA
7	COLETA
8	LOCAL SEGURO
9	AREA CRITICA
14	ADUANA

Tipo de Parada

Tipo de parada utilizado nos locais da viagem, referenciado no parâmetro tipo_parada

Parâmetros a serem enviados

Código	Descrição
1	PARADA
2	COLETA
3	ENTREGA
4	ORIGEM
5	DESTINO
6	REFEICAO
7	PERNOITE
8	PASSAGEM
9	ADUANA
10	MATRIZ
11	MANUTENCAO
12	ABASTECIMENTO
13	FISCALIZACAO
14	POLICIA
15	BALSA
16	PORTO

Tipo de Veículo

Tipo de Veículo utilizado nos cadastros de veículos

Parâmetros a serem enviados

Código	Descrição
1	CARRETA
2	CAVALO
3	TRUCK
4	MOTO
5	UTILITARIO CARGA
6	UTILITARIO PASSEIO

Fornecedor de Pesquisa

Constantes utilizadas para os Fornecedores de Pesquisa

Código	Descrição
1	OTNET
2	CENTURY
3	TRAFEGUS PESQUISA
4	TELECONSULT (BUONNY)
5	PROTEGEGR
6	GSAT
7	GLOBAL5
9	TRUST
10	GUEP
11	PAMCARY
12	SAFETY
13	ULTRACAD
14	REPENSE
8	OUTROS/NÃO INTEGRADO

Status de Pesquisa

Constantes utilizadas para os Status de Pesquisa

Código	Descrição
IN	EM CONFORMIDADE COM REGRAS DE SEGUROS
NI	EM DESACORDO COM AS REGAS DE SEGUROS
PE	EM PESQUISA
DI	DADOS INCONSISTENTES
BL	OBJETO PERTENCE A BLACKLIST DA GERENCIADORA

Tipo de Objeto de Pesquisa

Constantes utilizadas para os Tipos de Objeto de Pesquisa

Código	Descrição
MO	MOTORISTA
VC	VEICULO CARRETA
VM	VEICULO MOTOR
TR	TRANSPORTADOR
AJ	AJUDANTE

Tipo de Transporte Viagem

Constantes utilizadas para os Tipos de transporte na viagem

Código	Descrição
1	TRANSFERENCIA
2	DISTRIBUICAO
3	MATERIA PRIMA
4	MISTA
5	RETORNO
6	NACIONAL
7	EXPORTACAO
8	IMPORTACAO
9	CIRCUITO
11	COLETA
12	ENTREGA