WebService Trafegus Documentation

[v.2.44.4766]

General Trafegus Webservice Guidelines:

Trafegus system has a webservice integration that works based on the REST architecture, and your methods for sending and receiving data are available via GET, POST e PUT (Respectively to Search, Send or Update data).
All submissions and returns of this webservice will be done in JSON format.
To perform communication tests with this webservice applications like POSTMAN can be used.
All methods have Basic Authentication, HTTP protocol for accessing information. It is included in the HTTP request header as follows: Authorization: Basic {base64 credentials in user: password}

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

In the methods presented in this manual where arrays "[]" are used, several objects can be sent in the same request, as shown below: "veiculos":[ -- multiple vehicles can be sent within this array. { "placa":"GBK2100", "nro_liberacao":111, "escolta":"S" }, { "placa":"DPE1444", "nro_liberacao":222, "escolta":"N" } ]

POST for insertion:
http://customer.ip.address:port/ws_rest/public/api/viagem
http://customer.ip.address:port/ws_rest/public/api/transportador
http://customer.ip.address:port/ws_rest/public/api/embarcador
http://customer.ip.address:port/ws_rest/public/api/motorista
http://customer.ip.address:port/ws_rest/public/api/veiculo
http://customer.ip.address:port/ws_rest/public/api/pgr
http://customer.ip.address:port/ws_rest/public/api/ajudante

PUT for update:
http://customer.ip.address:port/ws_rest/public/api/viagem/IdViagem
http://customer.ip.address:port/ws_rest/public/api/transportador/IdTransportador
http://customer.ip.address:port/ws_rest/public/api/embarcador/IdEmbarcador
http://customer.ip.address:port/ws_rest/public/api/motorista/IdMotorista
http://customer.ip.address:port/ws_rest/public/api/veiculo/IdVeiculo
http://customer.ip.address:port/ws_rest/public/api/ajudante/IdAjudante
http://customer.ip.address:port/ws_rest/public/api/pgr/IdPGR

Note I: Before making any communication, please contact the Insurer or Trafegus Systems that can provide for you the environment IP, username and password.

Note II: The Trafegus Webservice service runs in a CentOS 6 (or higher) environment with the Apache HTTP server, so to be able to connect to it, the HTTP service must be Online and the CentOS server must have an Internet connection, it is also necessary to have the PHP tool version 5 (or higher) installed on the CentOS server.

Note III: The layout of the insertion (POST) and update (PUT) methods will be the same.

Note IV: All query methods (GET), if not entered id , will need to enter a id for the query to be based on and fetch the next 100 records.

Note V: When sending several objects for registration, if it is not possible to register any of them, the whole process will not be reversed, keeping in base those that were successfully registered and returning error to the one that failed and stopping the process.
Example: If 6 carriers are sent and the 3rd failed, the first 2 will not be reversed, return error message to the 3rd and will stop the process, not trying to register the 4th, 5th and 6th.

Search Carrier

Return carrier(s) information

To consult a specific carrier, add the ID(CPF)/CNPJ at the url:

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/transportador/123456

To query a carrier package add the last recived id in UltCodigo (each request fetches 100 records with the next data from the given id):

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/transportador?UltCodigo=123456

Note: When requested only one carrier the "transportador" key return will be just an object, not an array.

JSON Return

{
    "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
    }]
}

Search Shipper

Return Shipper(s) Information

To consult a specific Shipper, add the CNPJ at the url:

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/embarcador/123456

To query a Shipper package add the last recived id in UltCodigo (each request fetches 100 records with the next data from the given id):

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/embarcador?UltCodigo=123456

Note: When requested only one Shipper the "embarcador" key return will be just an object, not an array.

JSON Return

{
    "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
        }
    ]
}

Search Driver

Return Driver(s) Information

To consult a specific driver, add the ID(CPF) at the url:

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/motorista/123456

To query a driver package add the last recived id in UltCodigo (each request fetches 100 records with the next data from the given id):

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/motorista?UltCodigo=123456

Note: When requested only one driver the "motorista" key return will be just an object, not an array.

JSON Return

{
    "motorista": [{
                "codigo": 10,
        "cpf_motorista": "69371875569",
        "nome": "WS REST",
        "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
            }
        ]
    }]
}

Search Assistant

Return Assistant(s) Information

To consult a specific assistant, add the ID(CPF) at the url:

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/ajudante/123456

To query a assistant package add the last recived id in UltCodigo (each request fetches 100 records with the next data from the given id):

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/ajudante?UltCodigo=123456

Note: When requested only one assistant the "ajudante" key return will be just an object, not an array.

JSON Return

{
    "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"
    }]
}

Search Vehicle

Return Vehicle(s) Information

To consult a specific vehicle, add the ID(PLACA) at the url:

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/veiculo/ABC0001

To query a vehicle package add the last recived id in UltCodigo (each request fetches 100 records with the next data from the given id):

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/veiculo?UltCodigo=123456

Note: When requested only one vehicle the "veiculo" key return will be just an object, not an array.

JSON Return

 {
    "veiculo": [{
        "codigo": 9,
        "placa": "ONX0001",
        "frota": "123",
        "renavam": "00093084754",
        "chassi": "SKFAIS90DIF904884",
        "tipo_veiculo": 2,
        "lista_observacoes": [
            {
                "observacao": "OBSERVACAO DE EXEMLO 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",
        "terminais": [
            {
                "numero": "1988942",
                "tecnologia": "ONIXSAT",
                "codigo_versao_tecnologia": 8
            },{
                "numero": "TRI0003",
                "tecnologia": "ONIXSAT",
                "codigo_versao_tecnologia": 1
            }
        ],
        "transportadores": [
            {
                "documento_transportador": "29872062000175",
                "vinculo_contratual": 1
            }
        ]
    }]
}

Search PGR

Returns PGR(s) Information

Parameter	Required	Description
UltCodigo	YES	Id (id) of the last PGR.
Documento	YES	Vehicle Carrier CNPJ.

To consult a specific PGR, add the id at the url:

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/pgr/123456

To query a PGR package add the last recived id in UltCodigo (each request fetches 100 records with the next data from the given id):

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/pgr?UltCodigo=123456&Documento=010329231

Note: When requested only one PGR the "pgr" key return will be just an object, not an array.

JSON Return

{
    "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
    }]
}

Search Shipment

Returns Shipment(s) Information

To consult a specific shipment, add the shipment id at the URL:

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/viagem/123456

To query a shipment package add the last recived id in UltCodigo (each request fetches 100 records with the next data from the given id):

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/viagem?UltCodigo=123456

To consult the shipments completed on a date add the desired day value in the "DataFinalizacao" parameter:

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/viagem?DataFinalizacao=10/09/2018

To query shipments started between a date period, you must enter the values in the parameters DataInicioI (search start date) and DataInicioF (search end date)

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/viagem?DataInicioI=09/10/2018&DataInicioF=10/10/2018

To query shipments Started on a Date, you must enter the values in the Parameters DataEfetivacao

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/viagem?DataEfetivacao=09/10/2018

To query shipments Completed on a Date, you must enter the values in the parameters DataFinalizacaoI (search start date) and DataFinalizacaoF (search end date)

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/viagem?DataFinalizacaoI=09/10/2018&DataFinalizacaoF=10/10/2018

Note: When requested only one shipment the "viagem" key return will be just an object, not an array.

JSON Return

{
    "viagens": [
        {
            "cnpj_gr": null,
            "viag_codigo_externo": "00011",
            "operacao": "TRANSFERENCIA",
            "codigoSM": 12942,
            "viagemId": 12942,
            "documento_transportador": "54735256000176",
            "nome_transportador": "TRANSUPINO",
            "nome_embarcador": "TRANSUPINO EMBARCADOR",
            "descricao_pgr": "PGR COM TODOS OS CONTROLES",
            "cnpj_emba": null,
            "viag_data_cadastro": "2018-07-03 14:48:25",
            "veiculos": [
                {
                    "placa": "ONX0001",
                    "nro_liberacao": null,
                    "escolta": null
                }
            ],
            "motoristas": [
                {
                    "cpf_moto": "786135853-45",
                    "nro_liberacao": null,
                    "contatos": [
                        {
                            "email": null,
                            "fone": "TESTE",
                            "radio": null
                        },
                        {
                            "email": null,
                            "fone": "01",
                            "radio": null
                        }
                    ]
                }
            ],
            "ajudantes": [],
            "terminais": [
                {
                    "term_numero_terminal": "ONX0001",
                    "term_vtec_codigo": 6
                }
            ],
            "viag_ttra_codigo": 1,
            "tope_descricao": "AGRANEL",
            "viag_pgpg_codigo": null,
            "viag_carregado": "S",
            "viag_numero_manifesto": null,
            "viag_valor_merc_especifica": "0.00",
            "viag_valor_merc_nao_especifica": "18895142.00",
            "viag_valor_carga": "18895142.00",
            "viag_valor_ddr": "0.00",
            "viag_peso_total": "0.00",
            "viag_distancia": "585.29",
            "viag_previsao_inicio": null,
            "viag_previsao_fim": null,
            "viag_codigo_pai": null,
            "temperatura": [],
            "viag_descricao_carga": null,
            "viag_observacao": null,
            "viag_justificativa_liberacao": "LIBERADO",
            "distancia_restante": 559,
            "percentual_viagem": 40,
            "viag_data_inicio": "2018-10-11 09:36:03",
            "viag_data_fim": "2018-10-11 09:36:03",
            "previsao_fim_recalculada":  "2018-08-20 14:24:29",
            "valor_frete": [
                {
                    "viag_codigo": 9510,
                    "viag_numero_manifesto": null,
                    "viag_data_cadastro": "2018-09-04 15:06:37",
                    "viag_data_fim": "2018-10-11 09:36:03",
                    "viag_data_inicio": "2018-10-11 09:36:03",
                    "transportador": "TRANS TESTE",
                    "embarcador": null,
                    "descorigem": "CHAPECO",
                    "descdestino": "PRF - XANXERE/SC",
                    "descproprietario": "PROPRIETARIO",
                    "veic_placa": "ONX0001",
                    "viag_previsao_inicio": null,
                    "viag_previsao_fim": null,
                    "valor_frete_fechado": "1.00",
                    "valor_frete_km": "2.00",
                    "quantidade_ponto_fiscais": 1,
                    "valor_pedagio": "3.00",
                    "quantidade_motoristas": 2,
                    "valor_motora_adicional": "5.00",
                    "valor_ajudante": "4.00",
                    "valor_posto_fiscal_hora_adicional": "6.00",
                    "valor_hora_adicional": "7.00",
                    "valor_km_adicional": "8.00",
                    "valor_frete": null,
                    "valor_frete_ajustado": null,
                    "justificativa": null,
                    "tempo_previsto": null,
                    "tempo_real": " 00:00:00",
                    "rota_distancia": "37.99",
                    "rota_codigo": 3901,
                    "rota_descricao": "RT - 01",
                    "rota_identificador": "ID - RT - 01",
                    "viag_distancia_realizada": " 00.00",
                    "tipo_veiculo": "CAVALO"
                }
            ],
            "origem": {
                "vloc_descricao": "SHOPPING PATIO CHAPECO",
                "logradouro": null,
                "cep": null,
                "numero": null,
                "complemento": null,
                "bairro": null,
                "cida_descricao_ibge": null,
                "sigla_estado": null,
                "pais": null,
                "refe_latitude": "-27.0707338178",
                "refe_longitude": "-52.6269900798",
                "refe_raio": "0.00000",
                "refe_km": null,
                "refe_bandeira": null,
                "previsao_chegada": null,
                "previsao_inicio_espera": null,
                "previsao_fim_espera\t": null,
                "previsao_inicio_carregamento": null,
                "previsao_fim_carregamento": null,
                "previsao_inicio_descarregamento": null,
                "previsao_fim_descarregamento": null,
                "previsao_saida": null,
                "chegada_local":  "2018-08-20 11:24:29",
                "saida_local":  "2018-08-20 14:24:29",
                "local_baixa":  "CENTRO CHAPECO",
                "latitude_baixa": "-27.0707338178",
                "longitude_baixa":  "-52.6269900798",

                "conhecimentos": [
                    {
                        "vlco_numero": "numerocone1",
                        "vlco_valor": "18895891.00",
                        "vlco_cpf_cnpj": "518912606-42",
                        "notas_fiscais": [
                            {
                                "vnfi_numero": "nf2",
                                "vnfi_pedido": null,
                                "vnfi_valor": "874.00",
                                "vnfi_data_fat": null,
                                "vnfi_observacao": null,
                                "produtos": []
                            },
                            {
                                "vnfi_numero": "nf1",
                                "vnfi_pedido": null,
                                "vnfi_valor": "18895017.00",
                                "vnfi_data_fat": null,
                                "vnfi_observacao": null,
                                "produtos": [
                                    {
                                        "vpro_descricao": "SYNTHA 6",
                                        "vpro_tipo": "COMIDA",
                                        "vpro_quantidade": 1,
                                        "vpro_valor": "45.00"
                                    },
                                    {
                                        "vpro_descricao": "TELEVISORES",
                                        "vpro_tipo": "ELETRONICOS",
                                        "vpro_quantidade": 12,
                                        "vpro_valor": "1574581.00"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            },
            "destino": {
                "descricao": "FLORIANOPOLIS-SC",
                "logradouro": null,
                "cep": null,
                "numero": null,
                "complemento": null,
                "bairro": null,
                "cidade": null,
                "sigla_estado": null,
                "pais": null,
                "refe_latitude": "-27.5963000000",
                "refe_longitude": "-48.5491000000",
                "refe_raio": null,
                "refe_km": null,
                "refe_bandeira": null,
                "contatos": null,
                "previsao_chegada": null,
                "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":  "2018-08-20 11:24:29",
                "saida_local":  "2018-08-20 14:24:29",
                "local_baixa":  "CENTRO CHAPECO",
                "latitude_baixa": "-27.0707338178",
                "longitude_baixa":  "-52.6269900798",
                "conhecimentos": [
                    {
                        "vlco_numero": "conhe3",
                        "vlco_valor": "1.00",
                        "vlco_cpf_cnpj": "",
                        "notas_fiscais": []
                    },
                    {
                        "vlco_numero": "DONEHDES",
                        "vlco_valor": "123.00",
                        "vlco_cpf_cnpj": "",
                        "notas_fiscais": []
                    }
                ]
            },
            "locais": [
                {
                    "sequencia_parada": 2,
                    "tipo_parada": "ENTREGA",
                    "vloc_descricao": "P. LIGEIRINHO - PONTE SERRADA/SC",
                    "logradouro": null,
                    "cep": null,
                    "numero": null,
                    "complemento": null,
                    "bairro": null,
                    "cida_descricao_ibge": null,
                    "sigla_estado": null,
                    "pais": null,
                    "refe_latitude": "-26.8555555556",
                    "refe_longitude": "-52.0316666667",
                    "refe_raio": null,
                    "refe_km": null,
                    "refe_bandeira": null,
                    "previsao_chegada": null,
                    "previsao_inicio_espera": null,
                    "previsao_fim_espera\t": null,
                    "previsao_inicio_carregamento": null,
                    "previsao_fim_carregamento": null,
                    "previsao_inicio_descarregamento": null,
                    "previsao_fim_descarregamento": null,
                    "previsao_saida": null,
                    "chegada_local":  "2018-08-20 11:24:29",
                    "saida_local":  "2018-08-20 14:24:29",
                    "local_baixa":  "CENTRO CHAPECO",
                    "latitude_baixa": "-27.0707338178",
                    "longitude_baixa":  "-52.6269900798",
                    "conhecimentos": [
                        {
                            "vlco_numero": "conhe2",
                            "vlco_valor": "1.00",
                            "vlco_cpf_cnpj": "54735256000176",
                            "notas_fiscais": [
                                {
                                    "vnfi_numero": "nf23",
                                    "vnfi_pedido": "pedido",
                                    "vnfi_valor": "1.00",
                                    "vnfi_data_fat": "2018-07-03 00:00:00",
                                    "vnfi_observacao": "OBSERVA��O",
                                    "produtos": [
                                        {
                                            "vpro_descricao": "SYNTHA 6",
                                            "vpro_tipo": "SUPLEMENTP",
                                            "vpro_quantidade": 1,
                                            "vpro_valor": "1.00"
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ],
            "roteirizar": "S",
            "descricaoRota": "CHAPE FLORIPA"
        }
    ]
}

Search Invoices

Returns Invoices Information

Parameter	Required	Description
Viagem	YES	Shipment ID.
Documento	YES	Company Document ID (CPF/CNPJ) associated to the shipment.

To consult a specific invoice, add the invoice id at the URL:

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/viagemnotafiscal/123

Note: When requested only one invoice the "notasFiscais" key return will be just an object, not an array.

JSON Returns

{
    "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"
        }
    ]
}

Send Shipment

[POST] http://customer.ip.address:port/ws_rest/public/api/viagem

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Level	Type	Required	Description
viag_codigo_externo	0	Integer	NO	Customer Shipment ID
viag_ttra_codigo	0	Integer	YES	Transport Type (Check Constants In Documentation)
viag_pgpg_codigo	1	Integer	YES	PGR for Shipment Control
viag_carregado	0	String(1)	NO	Loaded Vehicle (Y/N)
documento_transportador	0	String(30)	YES	Cargo Carrier Document ID (CPF/CNPJ)
cnpj_emba	0	String(30)	NO	Cargo Shipper's CNPJ
viag_numero_manifesto	0	String(100)	NO	Packing List Number
viag_valor_merc_especifica	0	Float	NO	Specific Commodity Value
viag_valor_merc_nao_especifica	0	Float	NO	Non-specific Commodity Value
viag_previsao_inicio	0	Datetime (01/06/2015 00:00:00)	NO	Start Forecast Date/Time
viag_previsao_fim	0	Datetime (01/06/2015 00:00:00)	NO	End Forecast Date/Time
viag_valor_carga	0	Float	NO	Total Value of Charge
viag_valor_ddr	0	Float	NO	DDR Value
viag_peso_total	0	Float	NO	Total Weight of Cargo
viag_distancia	0	Float	NO	Shipment Distance in KM
viag_codigo_pai	0	Integer	NO	"Parent Shipment" Code
viag_descricao_carga	0	String(500)	NO	Cargo Description
viag_observacao	0	String(500)	NO	Shipment Observation
viag_justificativa_liberacao	0	String(500)	NO	Shipment Release Justification
ignorar_regras_pgrs	0	list (array)	NO	List of PGR items that should be ignored in PGR validation. To check which items can be ignored, consult the Trafegus technical team.
veiculos	0	list (array)	YES	Vehicle Information, Can Associate Several In This Array
placa	1	String(10)	YES	Shipment Vehicles Plate
nro_liberacao	1	Integer	NO	Vehicle Release Number
escolta	1	String(1)	NO	Escorting Vehicle (Y / N)
quantidade_embarcada	0	Integer	NO	Amount Shipped to Vehicle
motoristas	1	list (array)	NO	Driver Information, Can Associate Several In This Array
cpf_moto	1	String(20)	NO	Shipment Driver ID(CPF)
nro_liberacao	1	Integer	NO	Driver Release Number
contatos	1	List (array)	NO	Driver contacts, can associate several in this array
email	1	String(100)	NO	Contact Email
fone1	1	String(30)	NO	Contact Phone
radio	1	String(50)	NO	Contact Radio
ajudantes	0	List (Array)	NO	Assistants, Can Associate Several In This Array
cpf_ajudante	1	String(20)	NO	Assistant ID(CPF)
nro_liberacao	1	Integer	NO	Release Number
contatos	1	List (Array)	NO	Assistant Contacts, Can Associate Several In This Array
email	1	String(100)	NO	Contact Email
fone1	1	String(30)	NO	Contact Phone
radio	1	String(50)	NO	Contact Radio
terminais	0	List (Array)	NO	Shipment Terminals, Can Associate Several In This Array
term_numero_terminal	1	String(30)	NO	Terminal Number
tecn_tecnologia	1	String(50)	NO	Telematic
tope_descricao	1	String(50)	NO	Operation Type
tipos_produtos	0	List (Array)	NO	Shipment Product Types, Can Associate Several In This Array
produto	1	String(50)	NO	Product Type
valor	1	Float	NO	Shipment Product Value
temperatura	1	object	NO	Temperature Control
descricao	1	String(100)	NO	Temperature Description
de	1	Integer	NO	Initial Temperature Range
ate	1	Integer	NO	Final Temperature Range
sensores	1	Integer	NO	Enter 0 to Apply to All Sensors
sensor_01	1	String(1)	NO	Applies Sensor Range 1 (Y / N)
sensor_02	1	String(1)	NO	Applies Sensor Range 2 (Y / N)
sensor_03	1	String(1)	NO	Applies Sensor Range 3 (Y / N)
sensor_04	1	String(1)	NO	Applies Sensor Range 4 (Y / N)
sensor_05	1	String(1)	NO	Applies Sensor Range 5 (Y / N)
sensor_06	1	String(1)	NO	Applies Sensor Range 6 (Y / N)
sensor_07	1	String(1)	NO	Applies Sensor Range 7 (Y / N)
sensor_08	1	String(1)	NO	Applies Sensor Range 8 (Y / N)
sensor_09	1	String(1)	NO	Applies Sensor Range 9 (Y / N)
sensor_10	1	String(1)	NO	Applies Sensor Range 10 (Y / N)
rota_codigo	0	Integer	YES	Route Code
coordenadas	0	String	YES	Route Encrypted Polyline in Google Maps Format
rota_descricao	0	String	YES	Route Description
origem	0	object	YES	Shipment Origin Information
vloc_descricao	1	String(200)	YES	Description of Origin Place
logradouro	1	String(200)	NO	Origin Street
complemento	1	String(100)	NO	Origin Street Complement
cep	1	String(8)	NO	Street's ZIP(CEP) Code (Use as an aid not to duplicate)
numero	1	String(10)	NO	Origin Street Number
bairro	1	String(100)	NO	Origin Neighborhood
cida_descricao_ibge	1	String(100)	NO	City of Origin or IBGE Code (of city)
sigla_estado	1	String(2)	NO	Acronym UF (State of the City)
pais	1	String(50)	NO	Country
refe_latitude	1	Float	NO	Origin Latitude
refe_longitude	1	Float	NO	Origin Longitude
refe_raio	1	Float	NO	Origin Radius
refe_km	1	String(10)	NO	Origin Place in KM of highway
refe_bandeira	1	String(50)	NO	Origin Place Flag
associar_transportador	1	String(1)	NO	Associate as Carrier Origin (Y / N)
contatos	1	List (Array)	NO	Origin Place Contacts
email	2	String(100)	NO	Contact Email
fone1	2	String(30)	NO	Contact Phone
radio	2	String(50)	NO	Contact Radio
viag_data_consolidacao	2	Datetime (01/06/2015 00:00:00)	NO	Shipment Consolidation Date
previsao_chegada	2	Datetime (01/06/2015 00:00:00)	NO	Expected Arrival at Origin
previsao_inicio_espera	2	Datetime (01/06/2015 00:00:00)	NO	Origin Waiting Start Forecast
previsao_fim_espera	2	Datetime (01/06/2015 00:00:00)	NO	Origin Waiting End Forecast
previsao_inicio_carregamento	2	Datetime (01/06/2015 00:00:00)	NO	Origin Charge Start Forecast
previsao_fim_carregamento	2	Datetime (01/06/2015 00:00:00)	NO	Origin Charge End Forecast
previsao_inicio_descarregamento	2	Datetime (01/06/2015 00:00:00)	NO	Origin Discharging Start Forecast
previsao_fim_descarregamento	2	Datetime (01/06/2015 00:00:00)	NO	Origin Discharging End Forecast
previsao_saida	2	Datetime (01/06/2015 00:00:00)	NO	Exit Origin Forecast
conhecimentos	1	List (Array)	NO	Shipment Bill of Lading Information
vlco_numero	2	String(50)	YES	Bill of Lading Number
vlco_cpf_cnpj	2	String(30)	NO	Bill of Lading Customer Document (CPF/CNPJ)
vlco_valor	2	Float	YES	Bill of Lading Value
notas_fiscais	2	List (Array)	NO	Bill of Lading Invoice Information
vnfi_numero	3	String(20)	YES	Invoice Number
vnfi_pedido	3	String(20)	NO	InvoiceOrder Number
vnfi_valor	3	Float	YES	Invoice Monetary Value
vnfi_data_fat	3	Datetime (01/06/2015 00:00:00)	NO	Invoice Billing Date
vnfi_observacao	3	String(5000)	NO	Invoice Notes
produtos	3	List (Array)	NO	Invoice Products/Items
vpro_descricao	4	String(50)	YES	Invoice Product Description
vpro_tipo	4	String(50)	YES	Product Type
vpro_quantidade	4	Integer	YES	Product Amount
vpro_valor	4	Float	YES	Product Value
locais	0	List (Array)	NO	Shipment Locations, Can Associate Several In This Array
vloc_descricao	1	String(200)	YES	Origin Place Description
tipo_parada	1	integer	NO	Inform the code of the "stop type" of the place "Ex: 1 - If the place is a Stop, 2 - If the place is a Collection...", consult the method "Stop type parameters" present in the documentation
tipo_local	1	integer	NO	Inform the code of the "type of location" of the location "Ex: 1 - If the location is an Area of risk, 2 - If the location is an allowed point...", consult the method "Type of location parameters" present in the documentation
logradouro	1	String(200)	NO	Origin Street
complemento	1	String(100)	NO	Origin Street Complement
cep	1	String(8)	NO	Street's ZIP(CEP) Code (Use as an aid not to duplicate)
numero	1	String(10)	NO	Origin Street Number
bairro	1	String(100)	NO	Origin Neighborhood
cida_descricao_ibge	1	String(100)	NO	City of Origin or IBGE Code (of city)
sigla_estado	1	String(2)	NO	Acronym UF
pais	1	String(50)	NO	Country
refe_latitude	1	Float	NO	Origin Latitude
refe_longitude	1	Float	NO	Origin Longitude
refe_raio	1	Float	NO	Origin Radius
refe_km	1	String(10)	NO	Origin Place in KM of highway
refe_bandeira	1	String(50)	NO	Origin Place Flag
associar_transportador	1	String(1)	NO	Associate as Carrier Origin (Y / N)
contatos	1	List (Array)	NO	Origin Place Contacts
email	2	String(100)	NO	Contact Email
fone1	2	String(30)	NO	Contact Phone
radio	2	String(50)	NO	Contact Radio
previsao_chegada	2	Datetime (01/06/2015 00:00:00)	NO	Expected Arrival at Origin
previsao_inicio_espera	2	Datetime (01/06/2015 00:00:00)	NO	Origin Waiting Start Forecast
previsao_fim_espera	2	Datetime (01/06/2015 00:00:00)	NO	Origin Waiting End Forecast
previsao_inicio_carregamento	2	Datetime (01/06/2015 00:00:00)	NO	Origin Charge Start Forecast
previsao_fim_carregamento	2	Datetime (01/06/2015 00:00:00)	NO	Origin Charge End Forecast
previsao_inicio_descarregamento	2	Datetime (01/06/2015 00:00:00)	NO	Origin Discharging Start Forecast
previsao_fim_descarregamento	2	Datetime (01/06/2015 00:00:00)	NO	Origin Discharging End Forecast
previsao_saida	2	Datetime (01/06/2015 00:00:00)	NO	Exit Origin Forecast
conhecimentos	1	List (Array)	NO	Shipment Bill of Lading Information
vlco_numero	2	String(50)	YES	Bill of Lading Number
vlco_cpf_cnpj	2	String(30)	NO	Bill of Lading Customer Document
vlco_valor	2	Float	YES	Bill of Lading Value
notas_fiscais	2	List (Array)	NO	Bill of Lading Invoice Information
vnfi_numero	3	String(20)	YES	Invoice Number
vnfi_pedido	3	String(20)	NO	Client Order Number
vnfi_valor	3	Float	YES	Invoice Value
vnfi_data_fat	3	Datetime (01/06/2015 00:00:00)	NO	Invoice Billing Date
vnfi_observacao	3	String(5000)	NO	Invoice Notes
produtos	3	List (Array)	NO	Invoice Products
vpro_descricao	4	String(50)	YES	Invoice Product Description
vpro_tipo	4	String(50)	YES	Product Type
vpro_quantidade	4	Integer	YES	Product Quantity
vpro_valor	4	Float	YES	Product Value
destino	0	object	YES	Shipment Destination Information
vloc_descricao	1	String(200)	YES	Origin Place Description
logradouro	1	String(200)	NO	Origin Street
complemento	1	String(100)	NO	Origin Street Complement
cep	1	String(8)	NO	Street's ZIP(CEP) Code (Use as an aid not to duplicate)
numero	1	String(10)	NO	Origin Street Number
bairro	1	String(100)	NO	Origin Neighborhood
cida_descricao_ibge	1	String(100)	NO	City of Origin or IBGE Code (of city)
sigla_estado	1	String(2)	NO	Acronym UF
pais	1	String(50)	NO	Country
refe_latitude	1	Float	NO	Origin Latitude
refe_longitude	1	Float	NO	Origin Longitude
refe_raio	1	Float	NO	Origin Radius
refe_km	1	String(10)	NO	Origin Place in KM of highway
refe_bandeira	1	String(50)	NO	Origin Place Flag
associar_transportador	1	String(1)	NO	Associate as Carrier Origin (Y / N)
contatos	1	List (Array)	NO	Origin Place Contacts
email	2	String(100)	NO	Contact Email
fone1	2	String(30)	NO	Contact Phone
radio	2	String(50)	NO	Contact Radio
previsao_chegada	2	Datetime (01/06/2015 00:00:00)	NO	Expected Arrival at Origin
previsao_inicio_espera	2	Datetime (01/06/2015 00:00:00)	NO	Origin Waiting Start Forecast
previsao_fim_espera	2	Datetime (01/06/2015 00:00:00)	NO	Origin Waiting End Forecast
previsao_inicio_carregamento	2	Datetime (01/06/2015 00:00:00)	NO	Origin Charge Start Forecast
previsao_fim_carregamento	2	Datetime (01/06/2015 00:00:00)	NO	Origin Charge End Forecast
previsao_inicio_descarregamento	2	Datetime (01/06/2015 00:00:00)	NO	Origin Discharging Start Forecast
previsao_fim_descarregamento	2	Datetime (01/06/2015 00:00:00)	NO	Origin Discharging End Forecast
previsao_saida	2	Datetime (01/06/2015 00:00:00)	NO	Exit Origin Forecast
conhecimentos	1	List (Array)	NO	Shipment Bill of Lading Information
vlco_numero	2	String(50)	YES	Bill of Lading Number
vlco_cpf_cnpj	2	String(30)	NO	Bill of Lading Customer Document
vlco_valor	2	Float	YES	Bill of Lading Value
notas_fiscais	2	List (Array)	NO	Bill of Lading Invoices Information
vnfi_numero	3	String(20)	YES	Invoice Number
vnfi_pedido	3	String(20)	NO	Order Number
vnfi_valor	3	Float	YES	Invoice Monetary Value
vnfi_data_fat	3	Datetime (01/06/2015 00:00:00)	NO	Invoice Billing Date
vnfi_observacao	3	String(5000)	NO	Invoice Notes
produtos	3	List (Array)	NO	Invoice Products
vpro_descricao	4	String(50)	YES	Invoice Product Description
vpro_tipo	4	String(50)	YES	Product Type
vpro_quantidade	4	Integer	YES	Product Quantity
vpro_valor	4	Float	YES	Product Monetary Value
simular_sm	0	Boolean	NO	Defines whether to generate an SM or just do a simulation to record the data

Notes:
The "Level" column represents the alignment of XML / JSON tags and their sublevels.

For shipments sent without automatic routing and without route, only with locations, if the geolocator does not find any location, it will be registered in the shipment with latitude/longitude zero and will return "warning" for information.

JSON submission example for Trafegus system shipments (This method allows multiple shipments to be sent).

{
    "viagem": [ -- multiple SMs can be sent within this 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",
        "viag_pgpg_codigo": "11",
        "viag_valor_carga": 525100.22,
        "rota_codigo": 123,
        "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"
        },
        "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",
         "conhecimentos": [
                        {
                            "vlco_numero": "conhe2",
                            "vlco_valor": "1.00",
                            "vlco_cpf_cnpj": "54735256000176",
                            "notas_fiscais": [
                                {
                                    "vnfi_numero": "nf23",
                                    "vnfi_pedido": "pedido",
                                    "vnfi_valor": "1.00",
                                    "vnfi_data_fat": "2018-07-03 00:00:00",
                                    "vnfi_observacao": "OBSERVACAO"

                                }
                            ]
                        }
                    ]


        }],
        "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",
             "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"
                            },
                            {
                                "vnfi_numero": "nf1",
                                "vnfi_pedido": "321",
                                "vnfi_valor": "18895017.00",
                                "vnfi_data_fat": "2018-07-03 00:00:00",
                                "vnfi_observacao": "TESTE"
                            }
                        ]
                    }
                ]
        }
    }]
}

Fill Validation Detail:

Only insured monitoring requests (SMs) should be submitted. Being the carrier and / or the shipper of the shipment.
Fill in transport type is not required.
At least one vehicle and one driver are required for SM..
Filling in a terminal is not required. If not informed will be used the vehicle registration. If it does not have one then an error will be returned.
Entering the transaction type information can be fixed as per the rule: TRANSFERENCIA (for interstate shipment) and DISTRIBUICAO (for shipment within the same state).
The shipment start forecast date cannot be retroactive (before the current date/time).
End forecast date cannot be less than start forecast date.
The rules (PGR) for controlling the indicators will be fulfilled at the time of inclusion of the SM according to Carrier CNPJ + Transport Type + Cargo Value.
Regarding the origin, destination and places of the shipment, the Latitudes / Longitudes or a valid address must be informed (Street, zip(CEP) id, number, neighborhood, city, uf).
Origin, destination and shipment locations will be linked to the carrier / shipper for shipment controls.
If the tag "temperatura[n].descricao" is sent with a non-existent description, it will validate whether it has Minimum Value and Maximum Value and Controlled Sensor data. If this data exists, it will automatically register a new range and link it to the SM. If this data does not exist, it will block the SM registration, even if there is a linked range at the trip terminal.

Send Carrier

[POST] http://customer.ip.address:port/ws_rest/public/api/transportador

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Type	Required	Description
documento_transportador	text (30)	YES	Carrier ID(CPF)/CNPJ
nome	Text (50)	YES	Carrier Name
razao_social	Text (100)	NO	Carrier Corporate Name
ie_rg	Text (20)	NO	RG (natural person) or IE (legal entity)
logradouro	Text (200)	NO	Description of the Street
cep	Text (8)	NO	Street ZIP(CEP) Code
numero	Text (50)	NO	Street Number
complemento	Text (100)	NO	Street Neighborhood Description
bairro	Text (100)	NO	Street Neighborhood Description
cidade	Text (100)	NO	City of Origin or IBGE Code (according to IBGE standard table)
sigla_estado	Text (2)	NO	Street State Acronym
pais	Text (50)	NO	Country
documento_matriz	Text (30)	NO	Carrier Matrix ID(CPF)/CNPJ
senha	Texto (20)	NO	Carrier Password
roteiriza_automatico_sm	Integer	NO	Uses Automatic Routing in SM (0 no, 1 yes)
associa_motorista_sm	Integer	NO	Automatically Associate Drivers With the SM Carrier (0 no, 1 yes). Enter "1" by default.
associa_veiculo_sm	Integer	NO	Automatically Associate Vehicles With SM Carrier (0 no, 1 yes). Enter "1" by default.
contatos	List (Array)	NO	Driver Contacts
email	String(100)	NO	Contact Email
fone1	String(30)	NO	Contact Phone
Texto	String(100)	NO	Contact Name
embarcadores	List (Array)	NO	Shipper to link

Request to send Carrier's data:

{
    "transportador": [ -- multiple Transportes can be sent within this array.
    {
        "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,
        "senha": null,
        "roteiriza_automatico_sm": 1,
        "associa_motorista_sm": 1,
        "associa_veiculo_sm": 1,
        "embarcadores" : [
            {
            "documento_embarcador": "81832254000178"
            }
        ]
    }]
}

Return on Success:


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

Return on Error:

 {
    "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"
        }
    ]
}

Send Shipper

[POST] http://customer.ip.address:port/ws_rest/public/api/embarcador

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Type	Required	Description
cnpj_embarcador	Text (30)	YES	Shippers CNPJ
nome	Text (50)	YES	Shippers Name
razao_social	Text (100)	NO	Shippers Corporate Name
ie	Text (20)	NO	Shippers State Registration
logradouro	Text (200)	NO	Street Description
cep	Text (8)	NO	Street ZIP(CEP) Code
numero	Text (50)	NO	Street Street Number
complemento	Text (100)	NO	Street Neighborhood Description
bairro	Text (100)	NO	Street Neighborhood Description
cidade	Text (100)	NO	City of Origin or IBGE Code (according to IBGE standard table)
sigla_estado	Text (2)	NO	Street State Acronym
pais	Text (50)	NO	Country
cnpj_matriz	Text (30)	NO	Shippers Matrix ID(CPF)/CNPJ
roteiriza_automatico_sm	Integer	NO	Uses Automatic Routing in SM (0 no, 1 yes)
associa_motorista_sm	Integer	NO	Automatically Associate Drivers With the SM Carrier (0 no, 1 yes). Enter "1" by default.
associa_veiculo_sm	Integer	NO	Automatically Associate Vehicles With SM Carrier (0 no, 1 yes). Enter "1" by default.

Request to send Shipper's data:

{
    "embarcador": [ -- multiple shippers can be sent within this 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
        }
    ]
}

Return on Success:


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

Return on Error:

{
    "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"
        }
    ]
}

Send Driver

[POST] http://customer.ip.address:port/ws_rest/public/api/motorista

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
cpf_motorista	0	Text (20)	YES	Drivers ID(CPF)
nome	0	Text (50)	YES	Drivers Name
rg	0	Text (20)	NO	Drives RG
logradouro	0	Text (200)	NO	Street Description
cep	0	Text (8)	NO	Street ZIP(CEP) Code
numero	0	Text (50)	NO	Street Street Number
complemento	0	Text (100)	NO	Street Neighborhood Description
bairro	0	Text (100)	NO	Street Neighborhood Description
cidade	0	Text (100)	NO	Hometown or IBGE id (according to IBGE standard table)
sigla_estado	0	Text (2)	NO	Street State Acronym
pais	0	Text (50)	NO	Country
nro_cnh	0	Text (25)	NO	Driver's CNH Number
categoria_cnh	0	Text (10)	NO	Driver's CNH Category
validade_cnh	0	Datetime (01/06/2015 00:00:00)	NO	Driver's CNH Validity
senha	0	Text (15)	NO	Driver Password
vigilante	0	Text (1)	NO	Vigilant (Y/N)
nro_cnv	0	Integer	NO	Driver's CNV Number
validade_cnv	0	Datetime (01/06/2015 00:00:00)	NO	CNV Validity
nome_pai	0	String(100)	NO	Father's name
nome_mae	0	String(100)	NO	Mother's name
estado_civil	String(1)	NO	C: MARRIED S: SINGLE D: DIVORCED V: WIDOWER
moto_registro_cnh	String(12)	NO	CNH Registration Number
moto_orgao_emissor_cnh	String(10)	NO	CNH Issuing Agency
moto_data_primeira_habilitacao	0	Datetime (01/06/2015 00:00:00)	NO	Date of First License
moto_data_emissao	0	Datetime (01/06/2015 00:00:00)	NO	CNH Issue Date
data_nasc	0	Datetime (01/06/2015 00:00:00)	NO	Birth Date
rg_emissor	0	String(10)	NO	RG Issuing Agency
rg_uf	0	String(2)	NO	RG Issuing Acronym Sender
naturalidade_descricao_ibge	0	String(100)	NO	Hometown or IBGE Code (according to IBGE standard table)
naturalidade_uf_sigla	0	String(2)	NO	Acronym State Naturalness
cnh_seg	0	String(11)	NO	CNH Security Number
cnh_uf	0	String(2)	NO	CNH Issuing Acronym Sender
transportador	0	List (Array)	NO	Array of Carriers, Being Able to Associate Several in This Array
documento_transportador	1	Text (30)	NO	Carriers ID(CPF)/CNPJ
vinculo_contratual	1	Integer	NO	Type of Carrier Link. 1=fixed; 2=Aggregate; 3=Third
contatos	1	List (Array)	NO	Driver Contacts, Can Associate Several In This Array
email	1	String(100)	NO	Contact Email
fone1	1	String(30)	NO	Contact Phone
Texto	1	String(100)	NO	Contact Name

Request to send Driver's data:

{
    "motorista": [ -- multiple drivers can be sent within this array.
    {
        "cpf_motorista": "69371875569",
        "nome": "WS REST",
        "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
            }
        ]
    }]
}

Return on Success:


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

Send Assistant

[POST] http://customer.ip.address:port/ws_rest/public/api/ajudante

The submit JSON is identical to the JSON in the Method SearchAssistant. (Multiple objects can be sent)

Parameters to be sent:

Parameter	Group	Type	Required	Description
cpf_ajudante	1	String(20)	YES	Assistant ID(CPF)
nome	1	String(50)	YES	Persons Name
rg	1	String(20)	NO	Assistant RG
logradouro	1	String(200)	NO	Street Description
cep	1	String(8)	NO	Street ZIP(CEP) Code
numero	1	String(50)	NO	Street Street Number
complemento	1	String(100)	NO	Street Neighborhood Description
bairro	1	String(100)	NO	Street Neighborhood Description
cidade	1	String(100)	NO	City Description or City IBGE Code
sigla_estado	1	String(2)	NO	Street State Acronym
pais	1	String(50)	NO	Country
nome_pai	1	String(100)	NO	Father's Name
nome_mae	1	String(100)	NO	Mother's Name
data_nasc	1	Datetime (01/06/2015 00:00:00)	NO	Date of Birth
rg_emissor	1	String(10)	NO	RG Issuing Agency
estado_civil	1	String(1)	NO	C: MARRIED S: SINGLE D: DIVORCED V: WIDOWER
rg_uf	1	String(2)	NO	RG Sender State Acronym
naturalidade_descricao_ibge	1	String(100)	NO	Hometown or IBGE Code (according to IBGE standard table)
naturalidade_uf_sigla	1	String(2)	NO	Acronym State Naturalness
contatos	1	List (Array)	NO	Assistant Contacts, Can Associate Several In This Array
email	2	String(100)	NO	Contact Email
fone1	2	String(30)	NO	Contact Phone
Texto	2	String(100)	NO	Contact name
transportador	1	List (Array)	NO	Array of Carriers, Being Able to Associate Several in This Array
documento_transportador	2	Text (30)	NO	Carriers ID(CPF)/CNPJ

Return on Success



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

Return on Error:

    {
    "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"
        }
    ]
}

Send Vehicle

[POST] http://customer.ip.address:port/ws_rest/public/api/veiculo

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
placa	0	Text (10)	YES	Vehicle License Plate
tipo_veiculo	0	inteiro	YES	Vehicle Type. 1 = Cart; 2 = Tractor unit; 3 = Truck; 4 = Motorcycle; 5 = Loader; 6 = Ride Utility;
frota	0	Text (10)	NO	Vehicle Fleet
renavam	0	Text (10)	NO	Vehicle RENAVAM
chassi	0	Text (50)	NO	Vehicle Chassis
estacao_gr	0	Integer	NO	Tracking Station
veic_pgpg_codigo	0	Integer	NO	PGR Code
documento_proprietario	0	Text (30)	NO	Vehicle Owner's ID(CPF) / CNPJ
documento_transportador	0	Text (30)	NO	Vehicle Carrier ID (CPF) / CNPJ
documento_gestor	0	Text (30)	NO	Vehicle Fleet Manager ID(CPF)
senha_proprietario	0	Text (20)	NO	Vehicle Owner Password
senha_coacao	0	Text (20)	NO	Vehicle Duress Password
modelo	0	Text (50)	NO	Vehicle Model
marca	0	Text (50)	NO	Vehicle Brand
cpf_motorista	0	Text (20)	NO	Vehicle Driver ID(CPF)
ano_fabricacao	0	Text (4)	NO	Vehicle Manufacture Year
ano_modelo	0	Text (4)	NO	Vehicle Model Year
cor	0	Text (20)	NO	Vehicle Color
tamanho	0	numeric	NO	Vehicle Size
cidade_emplacamento	0	Text (100)	NO	City Plating or IBGE Code (according to IBGE standard table)
sigla_estado	0	Text (2)	NO	Acronym UF (State of the City)
pais	0	Text (50)	NO	Country
telefone	0	Text (20)	NO	Vehicle Phone
antt	0	Text (50)	NO	Vehicle ANTT
rntc	0	Text (10)	NO	Vehicle RNTC
crlv	0	Integer	NO	Vehicle CRLV
capacidade_maxima	0	Integer	NO	Load Capacity
unidade_medida	0	Constant	NO	FAR = BUNDLE LIT = LITER QUI = KG PAL = PALLET MEC = CUBIC_METER QUI = KILOS UVO = VOLUME_UNITS
tipo_unidade_medida	0	Constant	NO	CAX = BOXES PAL = PALLETS
tipo_carroceria	0	Constant	NO	1 = AMBULANCE 2 = FANLIGHT 3 = SHIELDED 4 = BUGGY 5 = CLOSED CABIN 6 = OPEN CABIN 8 = CONVERTIBLE 9 = VAN 10 = JEEP 11 = TRAILER 12 = MOTORCYCLES 13 = SIDER
combustivel	0	Constant	NO	0 = GASOLINE 1 = ETHANOL 2 = DIESEL 3 = FLEX
data_emissao	0	Datetime (01/06/2015 00:00:00)	NO	Document Issue Date
observacao_veiculo	0	Text (5000)	NO	Vehicle Observation
terminais	0	List (Array)	NO	Vehicle Terminals
numero	1	Text (30)	NO	Vehicle Terminal Number
tecnologia	1	String(50)	NO	Telematic
cod_versao_tecnologia	1	Integer	NO	Technology version code. Priority will be given to this field when informed, otherwise the "technology" field will be used to search for the terminal.
transportadores	0	List (Array)	NO	Carrier
documento_transportador	1	Text (30)	NO	Carrier ID(CPF)/CNPJ
vinculo_contratual	1	Integer	NO	Type of Link to the Carrier. 1=fixed; 2=Aggregate; 3=Third
lista_observacao	0	list (array)	NO	Observations

Request to send Vehicle's data:

 {
    "veiculo": [-- multiple vehicles can be sent within this 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",
        "terminais": [
            {
                "numero": "1988942",
                "tecnologia": 6608,
                cod_versao_tecnologia: 1
            },{
                "numero": "TRI0003",
                "tecnologia": 1
            }
        ],
        "transportadores": [
            {
                "documento_transportador": "29872062000175",
                "vinculo_contratual": 1
            }
        ],
        "lista_observacao": [
            "Observação 1",
            "Observação 2"
        ],
    }]
}

Return on Success:


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

Send Events

[POST] http://customer.ip.address:port/ws_rest/public/api/eventos

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
events	0	Array	YES	JSON main tag.
tipo_evento	1	Integer	YES	Fixed Code, According to The Table of Types of Events That Can Be Generated.
descricao	1	Text (100)	YES	Description of The Generated Event
placa	1	Text (10)	YES	Vehicle License Plate
numero_terminal	1	Text (30)	YES	Vehicle Device Number
tecnologia	1	Text (50)	YES	Device Telematic Description
data_bordo	1	Datetime (2018-10-02 11:34:29)	YES	Event Date on Board
posicao	1	Text (200)	YES	Description of Event Location Position
latitude	1	Text (15)	YES	Event Local Latitude
longitude	1	Text (15)	YES	Event Local Longitude
codigo_viagem	1	Integer	NO	Shipment ID

Request to send Event's data:

 {
    "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
        }
    ]
}

Return on Success:



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

Send Events Green Mile

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

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
	0	Array	Yes	Main json array
identificador	1	text(100)	Yes	From-to identifier of vehicles registered in the Green Mile license plate association wizard
tipo_evento	1	text(10)	Yes	Event code that will be generated
data_evento	1	text(50)	Yes	Event date, string must start in the format DD/MM/YYYY HH:MM
latitude	1	text(19)	Yes	Location Latitude
longitude	1	text(19)	Yes	Longitude of location

Request to Send Event's Green Mile data:

[
    {
        "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"
    }
]

Return in case of Success:

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

Return on Success, with exceptions:

{
    "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."
        }
    ]
}

Return in case of Error:

{
    "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."
        }
    ]
}

Send Route

[POST] http://customer.ip.address:port/ws_rest/public/api/rota

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
rotas	0	Array	YES	JSON Main Tag.
descricao	1	Text (500)	YES	Route Description
distancia	1	Real	NO	Route Distance (Required When Entered Coordinates)
coordenadas	1	Text	NO	Route Encrypted Polyline in Google Maps Format
pontos_rota	2	Array	YES	Route Points
descricao_local	2	Text (200)	YES	Place Description
tipo_local	2	Integer	YES	Stop Type (Available in Stop Type Parameters)
latitude	2	Text (15)	NO	Place Latitude
longitude	2	Text (15)	NO	Place Longitude
logradouro	2	Text (200)	NO	Place Street
complemento	2	Text (100)	NO	Place Street Complement
cep	2	Text (8)	NO	Place Street ZIP(CEP) Code
numero	2	Text (50)	NO	Place Number
bairro	2	Text (100)	NO	Place Neighborhood
cidade_descricao_ibge	2	Text (100)	NO	City Description or IBGE Code
sigla_estado	2	Text (2)	NO	Place Street State Acronym
pais	2	Text (50)	NO	Country
raio	2	real	NO	Place Radius
valores_frete	1	Array	NO	Freight values for the route.
tipo_veiculo	2	Integer	YES	Vehicle type.
tipo_carroceria	2	Integer	YES	Body type.
valor_frete_fechado	2	float	NO	Closed freight value.
valor_frete	2	float	NO	Freight value.
valor_pedagio	2	float	NO	Toll value.
valor_ajudante	2	float	NO	Helper value.
valor_motorista_adicional	2	float	NO	Additional driver fee.
valor_fiscais_adicionais	2	float	NO	Tax value.
valor_km_adicionais	2	float	NO	Additional KM value.
You must enter Latitude and Longitude, otherwise enter all other data for the detail of the street.

Request to send Route's data:

 {
    "rotas": [
         {
            "descricao": "43285- ",
            "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"
                }
            ],
            "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
                }
            ]
        }
    ]
}

Return on Success:



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

Send PGR

[POST] http://customer.ip.address:port/ws_rest/public/api/pgr

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
pgr	0	Array	YES	JSON Main Tag.
descricao	1	Text (100)	YES	PGR Description
pgr_padrao	1	Integer	NO	Default PGR to Use as Template for Cloning Detail and Action Settings
valor_minimo	1	Real	NO	PGR Minimum Value
valor_maximo_especifico	1	Real	NO	PGR Specific Maximum Value
valor_total	1	Real	NO	PGR Total Maximum Value
grau_risco	1	Integer	NO	1 = Very High; 2 = High; 3 = Medium; 4 = Low; 5 = Not Relevant
versoes	2	Array	NO	Telematics Versions
codigo_versao_tecnologia	2	Integer	NO	Telematic Version According to SearchTelematicVersions [GET] Method
sublimites	2	Array	NO	Product Sublimite
tipo_produto	2	Text (50)	NO	Product Type Description
valor_maximo	2	Real	NO	Maximum Value of This Product Type

Request to send PGR's data:

 {
    "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"

            }]
        }]
}

Return on Success:



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

Send Research

[POST] http://customer.ip.address:port/ws_rest/public/api/historico-pesquisa

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
TipoObjeto	1	Text (2)	YES	Search Object Type (Available in The Documentation on The Search Object Type)
Documento	1	Text (50)	YES	Search Owner Carrier Document
Objeto	1	Text (50)	YES	Research Object (License Plate / CPF / CNPJ)
Status	1	Text (2)	YES	Research Status (Available in The Search Status Documentation)
TipoValidade	1	Text (2)	YES	Research Expiration Type by Date or Shipment, Listed in "DT" or "VI"
FornecedorPesquisa	1	Integer	YES	Research Provider (Available in The Documentation From The Search Provider)
NumeroLiberacao	1	Text (50)	NO	Research Number Description
DataValidade	1	Datetime (2018-10-02 11:34:29)	NO	Research Expiration Date

Request to send Research's data:

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

}

Note: If the carrier and the object are not linked, a link will be created automatically upon successful request. This applies to the types "MO", "VC", "VM", and "AJ".

Send Areas

[POST] http://customer.ip.address:port/ws_rest/public/api/area

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
areas	0	Array	YES	JSON main tag.
area_descricao	1	Text (200)	YES	Area description.
classe_referencia	1	Text (50)	YES	Reference class description.
area_pontos	1	Array	YES	List of geographic points. Minimum 3 points
latitude	2	Text (15)	YES	Point Latitude.
longitude	2	Text (15)	YES	Point Longitude.

Request to send Points data:

{
    "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
                }
            ]
        }
    ]
}

Return on Success:

{
    "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": ""
}

Send Driver Non-Conformity

[POST] http://customer.ip.address:port/ws_rest/public/api/naoconformidademotorista

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
doc_cliente_suspensao	0	string	YES	CNPJ/CPF company generating the suspension.
cpf_motorista	0	string	YES	Driver's CPF for the suspension.
bloqueado_ate	0	Date/Time	NO	Deadline for the suspension to be effective. Retroactive dates to the suspension creation date are not allowed. Format: DD/MM/YYYY HH:MM
necessita_liberacao	0	string	NO	Parameter for driver release, accepting only 3 values: "NAO" (no), "ELEARNING" (e-learning), and "PRESENCIAL" (in-person)
doc_transportador	0	string	NO	CNPJ/CPF carrier sending the request.
motivo_suspensao	0	Array	NO	Array of suspension reasons descriptions listed on the web environment
descricao	1	string	NO	Suspension reason description
observacao	0	string (200)	NO	Non-Conformity observation.
motivo_interno	0	string (200)	NO	Non-Conformity internal reason.
codigo_modulo_elearning	0	integer	YES	E-Learning Module Code (obtained from the GET /moduloelearning method). This field is mandatory if the "necessita_liberacao" tag is filled as "E-LEARNING".

Request to send Driver Non-Conformity data:

{
    "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"
}

Return on Success:

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

Send E-Learning Modules

[POST] http://customer.ip.address:port/ws_rest/public/api/moduloselearning

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
nome_modulo	0	string	YES	E-Learning Module name.
status	0	string	YES	E-Learning Module status, accepting values "ATIVO" (active) or "INATIVO" (inactive).

Request to send E-Learning Modules:

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

Return on Success:

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

Send Checklist

Method responsible for registering new Checklists.

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

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
ativo	0	String(1)	No	If the checklist will be active (Y, N)
aprovado	0	String(1)	No	If the Checklist will be approved (Y, N)
env_email	0	String(1)	No	Send data by email (Y, N)
placa	0	String(10)	Yes	Motor vehicle license plate
terminal	0	Object	Yes	Terminal data
numero_terminal	1	String(10)	Yes	Terminal number
versao_tecnologia	1	Integer	Yes	Technology version
placa_carreta	0	String(10)	No	Trailer plate, send only one trailer
documento_proprietario	0	String(14)	Yes	Vehicle owner
documento_solicitante	0	String(14)	No	Checklist requester
cpf_motorista	0	String(11)	No	Driver's document
cod_viagem	0	Integer	No	Trip code
responsavel	0	String(100)	No	Responsible for the Checklist
tipo_checklist	0	String(2)	Yes	RO: Routine, PM: Post-maintenance, PC: Preload, TF: Cold Test
data_validade	0	Datetime(dd/mm/YYY H:i:s)	Yes	Checklist expiration date
documento_transportador	0	String(14)	Yes	Carrier document
documento_embarcador	0	String(14)	Yes	Shipper's document
motivo_recusa	0	String(200)	No	Reason for refusing the checklist
acessorios	0	Array	No	Accessory data list
codigo	1	Integer	Yes	Accessory code
instalado	1	String(1)	No	Installed(Y, N)
funcionando	1	String(1)	No	Working(Y, N)
problema	1	String(50)	No	Problem description
perifericos	0	Array	No	Peripheral data list
codigo	1	Integer	Yes	Peripheral code
instalado	1	String(1)	No	Installed(Y, N)
funcionando	1	String(1)	No	Working(Y, N)
problema	1	String(50)	No	Problem description

Request to send data

{
    "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"
        }
    ]
}

Return in case of success:

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

Return in case of error:

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

Send User

Method responsible for registering new Users and update Users.

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

Parameters to be sent to register new user:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Mandatory	Description
login	0	string(20)	Yes	User Login
senha	0	string(30)	Yes	User Password
documento_empresa	0	string(30)	Yes	User Company CPF/CNPJ
codigo_perfil	0	integer	No	User Profile Code
email	0	string(10)	No	User Email
pessoa	0	object	-	Person Data
nome	1	string(10)	Yes	User Name
documento	1	string(10)	Yes	User CPF/CNPJ
telefone	1	string(10)	No	User Phone

Request to send data

    {
        "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",
        },
    }

Success Response:


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

Error Examples:

Validation Error:


    {
        "success": [],
        "error": {
            "codigo": -1,
            "status": {
                "pessoa": {
                    "usuarioJaExiste": "Este documento ja esta cadastrado a um usuario"
                }
            }
        }
    }

Parameters to be sent to edit a user:

Send Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Mandatory	Description
login	0	string(20)	Yes	User Login
senha	0	string(30)	Yes	User Password
documento_empresa	0	string(30)	Yes	User Company CPF/CNPJ
codigo_perfil	0	integer	No	User Profile Code
email	0	string(10)	No	User Email
tempoSessaoWeb	0	integer	No
ativoPrestor	0	string(1)	No	Active Prestador
ativoEC	0	string(1)	No	Active EC
pessoa	0	object	-	Person Data
nome	1	string(50)		Name
documento	1	string(14)	Yes	User CPF/CNPJ
id	1	integer	No
status	1	integer	No	Status
planoGr	1	integer	No	Plano GR
cpf	1	string(14)	No	CPF
cnpj	1	string(18)	No	CNPJ
rg	1	string(20)	No	RG
orgaoEmissor	1	string(10)	No	Issuing Agency
estadoEmissorRg	1	integer	No	RG Issuing State
sexo	1	integer	No	Gender
dataNascimento	1	date (01/01/2000)	No	Birth Date
dataAdmissao	1	date (01/01/2000)	No	Admission Date
telefone	1	string(30)	No	Phone
email	1	string(255)	No	Email
nomeMae	1	string(100)	No	Mother's Name
nomePai	1	string(100)	No	Father's Name
empresa	1	integer	No	Company
perfil	1	integer	No	Profile
grupoVisualizacao	1	integer	No	Visualization Group
ativoPrestor	1	string(1)	No	Active Prestor
ativoEC	1	string(1)	No	Active EC
identificadorEC	1	string(9)	No	EC Identifier
tabelaEventosTipoOperacao_length	1	integer	No	Length of Event Type Operation Table
tabelaEventosOperador_length	1	integer	No	Length of Operator Event Table
tabelaEventosSupervisor_length	1	integer	No	Length of Supervisor Event Table

Request to send data

    {
        "login": "teste.usuario",
        "senha": "123",
        "documento_empresa": "62.215.500/0001-06",
        "email": "teste@teste.com",
        "tempoSessaoWeb": 30,
        "ativoPrestor": "S",
        "ativoEC": "N",
        "pessoa": {
            "id": 123456,
            "status": 1,
            "planoGr": 1,
            "cpf": "090.039.400-53",
            "nome": "USUARIO COM APP",
            "rg": "123456789",
            "orgaoEmissor": "SSP",
            "estadoEmissorRg": 1,
            "sexo": 1,
            "dataNascimento": "01/01/2000",
            "dataEmissaoRg": "01/01/2020",
            "nomeMae": "Mãe do Usuario",
            "nomePai": "Pai do Usuario",
            "telefone": "(48) 88888-8888",
            "email": "usuario@teste.com",
            "documento": "922.545.180-62",
            "perfil": 1,
            "tempoSessaoWeb": 30,
            "ativoPrestor": "S",
            "ativoEC": "N",
            "identificadorEC": "",
            "tabelaEventosTipoOperacao_length": 10,
            "tabelaEventosOperador_length": 10,
            "tabelaEventosSupervisor_length": 10,
            "grupoVisualizacao": 750,
            "empresa": 3083875
        }
    }

Success Response:

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

Error Examples:

Validation Error:

    {
        "success": [],
        "error": {
            "codigo": -1,
            "status": {
                "pessoa": {
                    "usuarioJaExiste": "Este documento ja esta cadastrado a um usuario"
                }
            }
        }
    }

Duplicate PGR

[POST] http://ip.of.client:port/ws_rest/public/api/planogr/duplicar

Parameters to be sent:

Authentication sent in the HTTP / HTTPS header.

Parameter	Type	Mandatory	Description
pgr	Int	Yes	Main JSON tag
descricao	text (100)	No	Description of PGR

Request for sending PGR data:

                    {
                        "pgr": 1234,
                        "descricao": "Example duplicate"
                    }

Success Response:

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

Update Shipment

[PUT] http://customer.ip.address:port/ws_rest/public/api/viagem/IdViagem

It has the same parameters as the Send Shipment method. However, the id "IdViagem" must be sent.

It is not allowed to change more than one record at a time, so this information should not be sent within an array..

It is not allowed to change completed shipments, if the shipment is started will only change the Route or Places and the PGR of the shipment, if the shipment is scheduled you can change all fields of the shipment.

Update Shipment Status

[PUT] http://customer.ip.address:port/ws_rest/public/api/viagem/IdViagem

Request to Update SM's/Shipment's Status:

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

The statuses allowed to change the shipment are: 1 = Effective; 2 = Canceled; 5 = Finished (any other ids will be rejected by the webservice).

It is not allowed to change more than one record at a time, so this information should not be sent within an array.

Update Invoices

[PUT] http://customer.ip.address:port/ws_rest/public/api/viagemnotafiscal/IdNotaFiscal

Invoice Status Request::

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

The date format must be the same as the example above (any other formats will be rejected by the webservice).

It is not allowed to change more than one record at a time, so this information should not be sent within an array.

Update Route

[PUT] http://customer.ip.address:port/ws_rest/public/api/rota/{route_id}

Parameters to be sent:

Authentication Sending in the HTTPS / HTTPS header
Fields designated as mandatory will be validated only if they are provided

Parameter	Group	Type	Required	Description
rotas	0	Object	YES	Main JSON Tag
descricao	1	Text (200)	NO	Route Description
identificador	1	Text (20)	NO	Route Identifier
documento_dono	1	Text (20)	NO	Route Owner Document Number
distancia	1	Real	NO	Route Distance (Mandatory when Coordinates are informed)
coordenadas	1	Text	NO	Route Polyline in GoogleMaps format
pontos_rota	2	Array	NO	Route Points
descricao_local	2	Text (200)	NO	Location Description
tipo_local	2	Integer	NO	Stop Type (available in Stop Type Parameters)
latitude	2	Text (15)	NO	Location Latitude
longitude	2	Text (15)	NO	Location Longitude
logradouro	2	Text (200)	NO	Location Street
complemento	2	Text (100)	NO	Street Complement
cep	2	Text (8)	NO	Location Street ZIP Code
numero	2	Text (50)	NO	Location Number
bairro	2	Text (100)	NO	Location Neighborhood
cidade_descricao_ibge	2	Text (100)	NO	City Description or IBGE Code
sigla_estado	2	Text (2)	NO	Street State Abbreviation
pais	2	Text (50)	NO	Country
raio	2	Real	NO	Radius
velocidade_media	1	Real	NO	Average Speed
tempo_total_parado	1	Real	NO	Total Stop Time(min)
tempo_tolerancia_atraso	1	Real	NO	Delay Tolerance Time(min)
valores_frete	1	Array	NO	Freight Values
tipo_veiculo	2	Integer	YES	Vehicle Type
tipo_carroceria	2	Integer	YES	Bodywork Type
valor_frete_fechado	2	Real	NO	Closed Freight Value
valor_frete	2	Real	NO	Freight Value
valor_pedagio	2	Real	NO	Toll Value
valor_ajudante	2	Real	NO	Assistant Value
valor_motorista_adicional	2	Real	NO	Additional Driver Value
valor_fiscais_adicionais	2	Real	NO	Additional Fiscal Value
valor_km_adicionais	2	Real	NO	Additional KM Value
It is necessary to inform Latitude and Longitude, otherwise inform all other data for the street detail.

Request to send Route data:

{
    "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
                }
            ]
        }
}

Return in case of Success

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

Update Carrier

[PUT] http://customer.ip.address:port/ws_rest/public/api/transportador/IdTransportador

It has the same parameters as the Send Carrier method. However, the id "IdTransportador" must be sent.

It is not allowed to change more than one record at a time, so this information should not be sent within an array.

Update Shipper

[PUT] http://customer.ip.address:port/ws_rest/public/api/embarcador/IdEmbarcador

It has the same parameters as the SendShipper method. However, the id "IdEmbarcador" must be sent.

It is not allowed to change more than one record at a time, so this information should not be sent within an array.

Update Driver

[PUT] http://customer.ip.address:port/ws_rest/public/api/motorista/IdMotorista

It has the same parameters as the SendDriver method. However, the id "IdMotorista" must be sent.

It is not allowed to change more than one record at a time, so this information should not be sent within an array.

Update Assistant

[PUT] http://customer.ip.address:port/ws_rest/public/api/ajudante/IdAjudante

It has the same parameters as the SendAssistant method. However, the id "IdAjudante" must be sent.

It is not allowed to change more than one record at a time, so this information should not be sent within an array.

Update Vehicle

[PUT] http://customer.ip.address:port/ws_rest/public/api/veiculo/Placa

It has the same parameters as the SendVehicle method. However, the id "Placa" must be sent.

It is not allowed to change more than one record at a time, so this information should not be sent within an array.

Update Driver Non-Conformity

[PUT] http://customer.ip.address:port/ws_rest/public/api/naoconformidademotorista/Non-ConformityCode

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
doc_cliente_suspensao	0	string	YES	CNPJ/CPF company generating the suspension.
cpf_motorista	0	string	YES	Driver's CPF for the suspension.
situacao	0	string	NO	non-Conformity status, wich can be: "BLOQUEADO", "LIBERADO", "LIBERADO PARA UMA SM"
bloqueado_ate	0	Date/Time	NO	Deadline for the suspension to be effective. Retroactive dates to the suspension creation date are not allowed. Format: DD/MM/YYYY HH:MM
necessita_liberacao	0	string	NO	Parameter for driver release, accepting only 3 values: "NAO" (no), "ELEARNING" (e-learning), and "PRESENCIAL" (in-person)
doc_transportador	0	string	NO	CNPJ/CPF carrier sending the request.
motivo_suspensao	0	Array	NO	Array of suspension reasons descriptions listed on the web environment
descricao	1	string	NO	Suspension reason description
observacao	0	string (200)	NO	Non-Conformity observation.
motivo_interno	0	string (200)	NO	Non-Conformity internal reason.
codigo_modulo_elearning	0	integer	YES	E-Learning Module Code (obtained from the GET /moduloelearning method). This field is mandatory if the "necessita_liberacao" tag is filled as "E-LEARNING".

Request to update Driver Non-Conformity data:

{
    "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"
}

Return on Success:

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

Update E-Learning Modules

[PUT] http://customer.ip.address:port/ws_rest/public/api/moduloselearning/ELearningModuleCode

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
nome_modulo	0	string	YES	E-Learning Module name.
status	0	string	YES	E-Learning Module status, accepting values "ATIVO" (active) or "INATIVO" (inactive).

Request to update E-Learning Modules:

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

Return on Success:

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

Update Terminals

[POST] http://client.ip:port/ws_rest/public/api/terminais

Parameters to be sent:

Sending Authentication in the HTTP / HTTPS header.

Parameter	Group	Type	Mandatory	Description
Array of objects	0	Array	Yes	Array of terminal objects
terminal	1	Object	Yes	Terminal object
codigo	2	int4	Yes*	Terminal code in the Trafegus database; Mandatory if the "number" and "version_code" fields are not entered
numero	2	varchar(30)	Yes*	Terminal number on the Trafegus base; Mandatory if the "code" field is not provided
codigo_versao	2	int4	Yes*	Technology version code in the Trafegus database; Mandatory if the "code" field is not provided
ativo	2	varchar(1)	Yes	Active/inactive information to be updated on the terminal. Accepts "Y" or "N" regardless of upper or lower case

Request for terminal activation/inactivation:

[
    {
        "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"
        }
    }
]

Return in case of success:

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

Return in case of Error:

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

Return in case of Success/Error:

[
    {
        "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."
            }
        ]
        }
    }
]

Search Vehicle Position

Returns Positions information.

To query the positions of a specific vehicle, the following parameters must be entered in the URL:

Parameter	Type	Required	Description
IdPosicao:	integer	Yes	Id (id) of the last position received (to fetch the ones after this id).
Documento	text	No	Vehicle Carrier Document
Documento	list(array)	No	Vehicle Carrier Document. Limit of 10 documents
DocumentosProp	list(array)	No	Vehicle Owner Document. Limit of 10 documents
Placa:	text	No	Vehicle License Plate
Placas:	list(array)	No	Vehicle License Plates. Limit of 30 Plates.
Qtde:	integer	No	Amount of record to be received (maximum 1000 if not entered maximum by default is 1000).
CodViag:	integer	No	Shipment ID
DataCadastroI:	date	No	Start Date (DD / MM / YYYY format) for registration period filter.
DataCadastroF:	date	No	End Date (DD / MM / YYYY format) for registration period filter.
SomenteUltimaPosicao:	integer	No	Search only the last position of the vehicle(s). (0 no, 1 yes)

Example to query data:

[GET] http://customer.ip.address:port/ws_rest/public/api/posicaoVeiculo?IdPosicao=999&Placa=ABC1234&DataCadastroI=01/05/2019&DataCadastroF=31/05/2019

Example to query the positions of a specific vehicle:

[GET] http://customer.ip.address:port/ws_rest/public/api/posicaoVeiculo?IdPosicao=999&Placa=ABC1234

Example to query the positions of all vehicles:

[GET] http://customer.ip.address:port/ws_rest/public/api/posicaoVeiculo?IdPosicao=999

NOTE

It's highly recommended to insert the period filter.

JSON Return:

{
    "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"
        }
      ]
}

Search Terminal Position

Returns Positions information

Parameters to be informed in the query:

Parameter	Required	Description
IdPosicao:	YES	Id of the last location received (to fetch the ones after this id).
Documento	YES	Vehicle Carrier CNPJ
NumeroTerminal	NO	Device Number
Tecnologia	NO	Device Telematic
Qtde:	NO	Amount of Record to Be Received (maximum 1000 if not entered maximum by default is 1000).
CodViag:	NO	Shipment ID.

Example for querying the positions of a specific terminal:

[GET] http://customer.ip.address:port/ws_rest/public/api/posicaoVeiculo?IdPosicao=01&NumeroTerminal=ONX0001&Tecnologia=ONIXSAT

Example to query the positions of all terminals:

[GET] http://customer.ip.address:port/ws_rest/public/api/posicaoVeiculo?IdPosicao=999

JSON Return

{
    "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"
        }
      ]
}

Search Last Vehicle Position

Returns Positions information

To query the positions of a specific vehicle, the following parameters must be entered in the URL:

Parameter	Required	Description
IdPosicao:	YES	Id (id) of The Last Position Received (to fetch the ones after this id).
Documento	YES	Vehicle Carrier CNPJ
Placa:	NO	Vehicle License Plate
Qtde:	NO	Amount of Record to Be Received (maximum 1000 if not entered maximum by default is 1000).
CodViag:	NO	Shipment ID.

Example to query the positions of a specific vehicle:

[GET] http://customer.ip.address:port/ws_rest/public/api/ultimaPosicaoVeiculo?IdPosicao=999&Placa=ABC1234

Example to query the positions of all vehicles:

[GET] http://customer.ip.address:port/ws_rest/public/api/ultimaPosicaoVeiculo?IdPosicao=999

JSON Return

{
    "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"
        }
      ]
}

Search Last Terminal Position

Returns Positions information

Parameters to be informed in the query:

Parameter	Required	Description
IdPosicao:	YES	Id of The Last Position Received (to fetch the ones after this id).
Documento	YES	Vehicle Carrier CNPJ
NumeroTerminal	NO	Terminal Number That is Positioning
Tecnologia	NO	Device Telematic
Qtde:	NO	Amount of Record To Be Received (maximum 1000 if not entered maximum by default is 1000).
CodViag:	NO	Shipment ID.

Example for querying the positions of a specific terminal:

[GET] http://customer.ip.address:port/ws_rest/public/api/ultimaPosicaoVeiculo?IdPosicao=01&NumeroTerminal=ONX0001&Tecnologia=ONIXSAT

Example to query the positions of all terminals:

[GET] http://customer.ip.address:port/ws_rest/public/api/ultimaPosicaoVeiculo?IdPosicao=999

JSON Return

{
    "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"
        }
      ]
}

Search last peripheral receive [GET]

Return the last peripherals values

Parameters to be informed in the query:

Parameter	Required	Description
Documento	NO	CPF/CNPJ Carrier of the vehicle (if traveling) or owner (not traveling)
Placa	NO	Vehicle plate
Qtde	NO	Number of records to be returned
GrupoVisualizacao	NO	Optional filter to apply or not a filter per vehicle display group. Values 1= Apply Group. 0 = Do not apply. If this parameter is not entered, the visualization group filter will not be applied.
PerifericosPadroes	NO	Optional filter in list format (array) to define which peripherals you want to return
UltCodigo	NO	Code of the last record inserted (to search for records after this code).

Example to query the positions of all available registers:

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

Example for querying the positions of a specific filter:

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

JSON Return

                    {
                        "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"
                            }
                        ]
                    }

Search Alerts

Method to returns information about the vehicles tracking sensors.

For querying tracking sensors data of an specific vehicle must be informed the following parameter in the URL:

Parameter	Required	Description
Placa:	YES	Tractor Unit Plate.
UltCodigo:	YES	Id of the last record received (to fetch the records after this id in the next request).
PlacaCarreta:	NO	Cart Plate
NroTerminal:	NO	Tracker ID
Perifericos:	NO	Array of default alerts IDs (obtained in the method BuscaListaPerifericoPadrao);
DataCadastroI:	NO	Initial Date (format DD/MM/YYYY)for filtering the period of the alerts registration.
DataCadastroF:	NO	Final date (format DD/MM/YYYY) for filtering the period of the alerts registration.

Example for querying data of an specific vehicle:

[GET] http://ip.do.client:porta/ws_rest/public/api/periferico?UltCodigo=100&Placa=ABC1234

Example for querying data of an specific vehicle, with filters by alerts, cart plate, tracker ID placa de carreta, and period:

[GET] http://ip.do.client:porta/ws_rest/public/api/periferico?UltCodigo=100&Placa=ABC1234&PlacaCarreta=CAR2323&NroTerminal=188212&Perifericos=[20,25,31]&DataCadastroI=01/02/2021&DataCadastroF=02/02/2021

Notes

It's highly recommended to insert the period filter.
The method will return up to 500 records in each request.
The vehicle plate filled in the query param, must belong to user the View Group (user authenticated in the WS). Otherwiser, no information will be returned.
The query will return from a maximum of 7 days prior to the current date of the request.

JSON Response

                    {
                        "recebimentos_perifericos": [
                            {
                                "Codigo": 1,
                                "Placa": "ABC1234",
                                "NumeroTerminal": "xxxxxxxx",
                                "Tecnologia": "ONIXSAT",
                                "PerifericoPadrao": "EVENTO DE VELOCIDADE",
                                "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": "EMPORIO MORENA",
                            },
                            {
                                "Codigo": 2,
                                "Placa": "ABC1234",
                                "NumeroTerminal": "xxxxxxxx",
                                "Tecnologia": "ONIXSAT",
                                "PerifericoPadrao": "EVENTO DE IGNI��O",
                                "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": "EMPORIO MORENA",
                            }
                        ]
                    }

SearchDefaultAlertsList

Method to return the default alert list pre-registered in the Trafegus system.

For querying the full list of Trafegus default alerts, the following parameters can be informed optionally in the URL:

Parameter	Required	Description
Codigo:	NO	Trafegus default alert ID.
Descricao:	NO	Default alert description.

Example for querying the full list of Trafegus default alerts:

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

Example for querying an specfic default alert, by ID:

[GET] http://ip.do.cliente:porta/ws_rest/public/api/eventoperifericopadrao?codigo=32

JSON Response

                    {
                        "perifericos_padrao": [
                            {
                                "codigo": 32,
                                "descricao": "EVENTO DE BLOQUEIO",
                                "ativo": "S",
                                "tipo_valor": "inteiro"
                            }
                        ],
                    }

Search Telematics Versions

Returns Information about Telematics Versions

Parameters to Be Informed in The Query:

Parameter	Required	Description
Tecnologia	NO	Telematic Description

Example to query the versions of a specific telematic:

[GET] http://customer.ip.address:port/ws_rest/public/api/versaoTecnologia?Tecnologia=ONIXSAT

Example for querying data from all telematic versions:

[GET] http://customer.ip.address:port/ws_rest/public/api/versaoTecnologia

JSON Return

{
    "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"
        }
      ]
}

Search Route

Returns information about Consumer User Company Routes

Parameters to Be Informed in The Query:

Parameter	Required	Description
UltCodigo	NO	Last Route ID Received (to fetch the ones after this id).
RotaCodigo	NO	Route ID
valores_frete	NO	Add route freight values
At least one of the mentioned parameters must be passed, if the search is batch (UltCodigo) the batch is limited to 100 records.

Example to query the data of a specific Route:

[GET] http://customer.ip.address:port/ws_rest/public/api/rota?RotaCodigo=123

Example to query a route batch (100 Register):

[GET] http://customer.ip.address:port/ws_rest/public/api/rota?UltCodigo=1

Example to return freight values data for route

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

JSON Return

{
    "rotas": [
        {
            "id_rota": 3952,
            "descricao": "43285- ",
            "distancia": "15274.66",
            "data_cadastro": "2018-10-08 09:48:53",
            "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": 59763523,
                    "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
                }
            ]
        }
    ]
}

Search Events

Returns information about events generated on the Trafegus system.

Parameters to be informed in the query:

Parameter	Required	Description
UltCodigo	YES	Last event id Received (to fetch the ones after this id).
Placa	NO	Vehicle License Plate
CodViag	NO	Shipment ID
tipoEvento	NO	The code of some event type

Example to query the data of a specific Plate or Shipment:

[GET] http://customer.ip.address:port/ws_rest/public/api/eventos?UltCodigo=1&Placa=PLA0001&CodViag=141

Example to query a event batch (100 Register):

[GET] http://customer.ip.address:port/ws_rest/public/api/eventos?UltCodigo=1

Example to query data by event type, being able to enter up to 20 integers:

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

JSON Return

{
    "eventos": [
        {
            "id_evento": 43457,
            "tipo_evento": 113,
            "descricao_tipo_evento": "EVENTO DE MACRO DE INICIO DE PERNOITE",
            "descricao": "INICIO DE PERNOITE.",
            "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,
            "hodometro": 1000
        },
        {
            "id_evento": 43454,
            "tipo_evento": 113,
            "descricao_tipo_evento": "EVENTO DE MACRO DE INICIO DE PERNOITE",
            "descricao": "INICIO DE PERNOITE.",
            "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,
            "hodometro": 1100
        }
    ]
}

Search Non-Conformity

Returns information about the Non-Conformity generated in the Trafegus system

Parameters to be informed in the query:

Parameter	Required	Description
UltCodigo	YES	Last Non-Conformity ID Received (to fetch later registers than this id).
Placa	NO	Vehicle License Plate
CodViag	NO	Shipment ID

Example to query the data of a specific Plate or Shipment:

[GET] http://customer.ip.address:port/ws_rest/public/api/naoconformidades?UltCodigo=1&Placa=PLA0001&CodViag=141

Example to query a Non-Conformity batch (100 Register):

[GET] http://customer.ip.address:port/ws_rest/public/api/naoconformidades?UltCodigo=1

JSON Return

{
    "Eventos": [
        {
            "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": "JUVENAL DOS CHECKLIST",
        },
        {
            "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,
        }
    ]
}

Search Tracking Stations

Return Tracking Station(s) Information

Example to query tracking stations:

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/estacaoRastreamento

JSON Return

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

Search Research

Returns Research(s) Information

Parameters to be informed in the query:

Parameter	Required	Description
UltCodigo	YES	Last Research id Received (to fetch the ones after this id).
Documento	NO	Research Owner Document
Objeto	NO	Research Object (License Plate/ID(CPF)/CNPJ)
To search for a specific Object you must also enter the Research Owner Document

Example for querying Research data

[GET] http://customer.ip.address:port/ws_rest/public/api/historico-pesquisa?UltCodigo=1

JSON Return

{
    "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"
        }
    ]
}

Search Logistics Data

Returns fleet data information

Required:
To view shipments by a specific carrier, add the carrier document at the URL:

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/frota?Documento=08879885554

You need to enter the search filter type (UPOS = Last Position / INI = Shipment Start Date / END = Shipment End Date):

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/frota?Tipo=UPOS

Need to enter the Research start and end date (dd / mm / yyyy hh: nn: ss):

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/frota?DataInicio=01/01/2019 00:00:00&DataFim=02/01/2019 00:00:00

Example of searching with required data:

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

Optional:
To see a specific shipment, add the shipment id at the URL:

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/frota?CodViag=123456

To query a specific License Plate, add the License Plate at the URL:

Ex: [GET] http://customer.ip.address:port/ws_rest/public/api/frota?Placa=PLA0001

JSON Return

{
    "Frota": [
        {
            "viagem_codigo": 9803,
            "placa": "LUC0001",
            "frota": null,
            "rota_codigo": 4058,
            "rota_descricao": "TESTE VIAGEM FROTA",
            "viagem_status": "EM VIAGEM",
            "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,
            "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
        }
    ]
}

Send Research TrafegusCAD

[POST] http://customer.ip.address:port/ws_rest/public/api/v1/pesquisa

Parameters to be sent:

Sending Authentication in HTTP / HTTPS header.

Parameter	Group	Type	Required	Description
TipoObjeto	1	Text (2)	YES	Search Object Type (available in the documentation on the Search Object Type)
Documento	1	Text (50)	YES	Research Owner Carrier Document
Objeto	1	Text (50)	YES	Research Object (License Plate / ID(CPF) / CNPJ)
Renovacao	1	Text (1)	YES	Research Renewal (Y / N)

Request to Submit Research Data:

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

}

Search Research TrafegusCad

Returns Research(s) Information

Parameters to be informed in the query: <

Parameter	Required	Description
Tipo	YES	Search Object Type (available in the documentation on the Search Object Type)
Documento	YES	Research Owner Document
Objeto	YES	Research Object (License Plate/ID(CPF)/CNPJ)

Example for querying Research data

[GET] http://customer.ip.address:port/ws_rest/public/api/consulta?UltCodigo=1

JSON Return

{
    "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"
        }
    ]
}

Search Place Status

Returns Information about the Place Status.

Parameters to be informed in the query:

Parameter	Required	Description
local	NO	Place Code
viagem	NO	Shipment ID

Example to query data

[GET] http://customer.ip.address:port/ws_rest/public/api/baixalocal?UltCodigo=1

JSON Return

{
    "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
                }
            ]
        }
    ]
}

Search Driver Non-Conformity

Returns information about the Driver Non-Conformity generated in the Trafegus system

Parameters to be informed in the query:

Parameter	Required	Description
ultimoCodigo	NO	Last Driver Non-Conformity ID Received (to fetch later registers than this id).
cpfMotorista	NO	Driver's CPF Document
documentoClienteSupensao	NO	Suspension Client CPF/CNPJ Document
documentoTransportador	NO	Carrier CNPJ Document

Example to query Driver Non-Conformity data in batches of 1000 records:

[GET] http://customer.ip.address:port/ws_rest/public/api/naoconformidademotorista?UltCodigo=1

JSON Return

{
    "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
        }
    ]
}

Search E-Learning Modules

Returns information about the E-Learning Modules generated in the Trafegus system

Example to query E-Learning Modules:

[GET] http://customer.ip.address:port/ws_rest/public/api/moduloselearning

JSON Return

{
    "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": []
}

Search CheckList

Return CheckList(s) information

Parameters to be informed in the query:

Parameter	Required	Description
UltCodigo	YES	Last Code to Be Send
DataCadastroI	NO	Initial Registration Date
DataCadastroF	NO	Final Registration Date
veiculo	NO	Vehicle Code
BuscarAlteracoes	NO	Instead of Filtering by CheckList Code, Filters by Change Code
IncluirDetalhes	NO	Returns CheckList and Terminal Items

Example to query data

[GET] http://customer.ip.address:port/ws_rest/public/api/checkList

JSON Return

{
    "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"
        }
    ]
}

Search System Records

Returns System Logs Information

Query Filters:

Parameter	Required	Description
sessao	NO	Session Code
chave	NO	Key Code
limit	NO	Maximum number of records to List
offset	NO	Records offset from the first

Example to query data

[GET] http://customer.ip.address:port/ws_rest/public/api/sistemaregistro

JSON Return

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

Search MacrosMensagens

Fetches the Macros and Mensagens Livres sent by the terminal.

Query Filters:

Parameter	Required	Description
numero_terminal	Yes¹	Terminal number
versao_tecnologia	Yes²	Version code of the terminal's telematic
tecnologia	Yes²	Name of the terminal's telematic
terminais	Yes¹	Array for filtering by multiple terminals and telematics, in the format: [["terminal_number_1", "telematic_1"], ["terminal_number_2", "telematic_2"], ["terminal_number_n", "telematic_n"]]
documento_proprietario	Yes³	If provided, only macros sent by vehicles whose owner matches the specified document (the document can be either a CPF or CNPJ)
texto	No	If this parameter is provided, it will return macros that contain the specified text (matches the 'texto' field, not the 'descrição' field)
data_ultima_posicao	No	If this parameter is provided, only macros sent after this date will be returned (format yyyy-mm-dd hh:mm:ss)
codigo_ultima_posicao	No	If provided, only macros sent after the macro with this code will be returned
tipo_informacao	No	If provided, only messages of the specified type (MACRO or MENSAGEM) will be returned. If this filter is not provided, both MACRO and MENSAGEM information will be returned.
placa	No	If provided, only messages sent by the vehicle corresponding to the specified plate will be returned.
limit	No	Maximum number of records to be returned
offset	No	Starting record to be returned

¹ - It is mandatory to provide either the terminal and technology list or the terminal number
² - It is mandatory to provide either the technology name or the technology version code, if the terminal array is not provided
³ - It is mandatory to provide the owner's document if the terminal array, technology name, or technology version code is not provided

Request Example

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

Response

A list of objects in the following format

número: Macro number
texto: Macro text
data_computador_bordo: Date the macro was sent (format yyyy-mm-dd hh:mm:ss)
latitude: Macro latitude (in decimal format)
longitude: Macro longitude (in decimal format)
descricao: Macro description
mascara: Macro mask
numero_terminal: Terminal number
versao_tecnologia: Telematic version of the terminal
tecnologia: Telematic name of the terminal
localizacao: Description of the location or proximity at the time the message or macro was sent
placa: Vehicle plate description associated with the message/macro tracker
frota: Fleet description of the vehicle associated with the message/macro tracker
hodometro: Odometer according to the last received position of the tracker
motorista: Driver name associated with the message
cpf_motorista: Driver's CPF associated with the message

JSON Response

{
    "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"
        }
    ]
}

SearchTerminals

Returns a list of terminals according to the filters used in the request.

To perform a terminal query, simply consult the url:

Ex1: [GET] http://client.ip:port/ws_rest/public/api/terminais

Or use the parameters of your choice in the url:

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

Parameter	Mandatory	Description
ultCodigo	No	Last code returned, to consult from this code forward. Request is limited to 1000 return records.
codigo	No	Terminal code in the Trafegus database.
numero	No	Terminal number in the Trafegus base.
codigo_versao	No	Technology version code in the Trafegus database.
codigo_tecnologia	No	Technology code in the Trafegus database.
descricao_tecnologia	No	Description of the technology in the Trafegus base, the The search will be carried out in such a way that the description of the technology contains the description informed in the parameter, without considering capital letters or lowercase.
ativo	No	Terminal status in the Trafegus base. Accepts "Y" or "N" without considering upper or lower case.

JSON Success Return

[
{
"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"
}
]

Search Data Overnight

Returns driver overnight information.

Parameter	Required	Description
data_inicio	YES	Start date of driver point.
data_fim	YES	End date of driver point.
cpf_motorista	NO	Driver's CPF.
doc_transportador	NO	Transporter CPF/CNPJ.
placa	NO	Vehicle plate.

To consult a specific driver, add the driver's CPF in the URL:

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

To consult a specific vehicle, add the vehicle's plate to the URL:

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

To consult a specific transporter, add the transporter's document to the URL:

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

JSON Response

                    {
                        "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"
                            }
                        ]
                    }

Search Concreserv Invoice Data

Returns data from an invoice, the data returned comes from an external API.

The search only refers to an invoice, informing the invoice key:

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

Successful JSON return

                    {
                        "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": []
                    }

Returns in case of error or invoice not found

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

Place Type

Location type to associate with the Carrier, used in the tipo_local parameter

Parameters to be sent

Code	Description
1	RISK AREA
2	ALLOWED POINT
3	PROHIBITED POINT
4	ORIGIN
5	DESTINATION
6	DELIVERY
7	COLLECT
8	SAFE PLACE
9	CRITICAL AREA
14	CUSTOMS

Break Type

Stop type used at shipment locations, referenced in tipo_parada parameter

Parameters to be sent

Code	Description
1	STOP
2	COLLECT
3	DELIVERY
4	ORIGIN
5	DESTINATION
6	MEAL
7	OVERNIGHT STAY
8	PASSAGE
9	CUSTOMS
10	MATRIX
11	MAINTENANCE
12	SUPPLY
13	SUPERVISION
14	POLICE
15	FERRY
16	PORT
17	Custom Waypoint
18	Invoice Exchange

Vehicle Type

Vehicle Type Used in Vehicle Registration

Parameters to be sent

Code	Description
1	Cart
2	Tractor Unit
3	TRUCK
4	Motorcycle
5	LOAD UTILITY
6	UTILITY TOUR

Search Provider

Constants Used for Research Providers

Code	Description
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	OTHERS / NOT INTEGRATED

Search Status

Constants used for Search Status

Code	Description
IN	ACCORDING TO INSURANCE RULES
NI	DISAGREEING WITH INSURANCE RULES
PE	IN RESEARCH
DI	INCONSISTENT DATA
BL	OBJECT BELONGS TO MANAGER BLACKList

Search Object Type

Constants Used for Search Object Types

Code	Description
MO	DRIVER
VC	REEL VEHICLE
VM	MOTOR VEHICLE
TR	CARRIER
AJ	ASSISTANT

Shipment Transportation Type

Constants Used for Shipment Types of Transportation

Code	Description
1	TRANSFER
2	DISTRIBUTION
3	RAW MATERIAL
4	MIXED
5	REGRESS
6	NATIONAL
7	EXPORT
8	IMPORT
9	CIRCUIT