WS608 - Export Dwell Time Analysis report

This integration aims to export Comprovei's length of stay analysis report

Authentication

• Calls will have transport-level authentication (Basic Authentication);
• Request user / password from the account administrator.

Features

• URL

  https://api.comprovei.com.br/api/1.1/util/export/documentProcessTimes

• Method:

  POST

• URL parameter:

  No parameters

• Example:

  {
      "headers": {
          "username": "usuario",
          "password": "senha"
      },
      "body": {
          "formato_exportacao" : "xml",
          "filtros": {
              "data_inicial": "2020-01-01",
              "data_final": "2020-01-01",
              "data_emissao_inicial": "2020-01-01",
              "data_emissao_final": "2020-01-01",
              "diretoria": ["String"],
              "especie_documento": ["String", "String2"],
              "regioes": ["String", "String2"],
              "transportadoras":["String", "String2"],
              "codigo_transportador": ["String", "String2"],
              "embarcadores":["String", "String2"],
              "placa_veiculo": ["String", "String2"],
              "tipo_rota": ["int", "int2"],
              "numero_rota": ["int", "int2"],
          },
          "campos": [
              "Rota",
              "Data",
              "Região",
              "Motorista",
              "Placa",
              "Documento",
              "Código cliente",
              "CNPJ Cliente",
              "Cliente",
              "Endereço",
              "Bairro",
              "Cidade",
              "Estado",
              "CEP",
              "Latitude",
              "Longitude",
              "Início de Viagem",
              "Início Pausa",
              "Fim Pausa",
              "Chegada",
              "Início de Descarga",
              "Fim de Descarga",
              "Registro da Foto",
              "Registro da Anotação",
              "Registro de Assinatura",
              "Fim da Entrega",
              "Tempo de Permanência",
              "Tempo de viagem",
              "Tempo de viagem + permanência",
              "Sequência original",
              "Sequência realizada",
              "Embarcador",
              "Volumes",
              "Distância Percorrida",
              "Pedido",
              "Base Origem",
              "Base Destino",
              "Data Agendamento",
              "Data Últ. Ocorr.",
              "Ultima Ocorrência",
              "Status Documento",
              "Transportadora",
              "Tempo de Espera",
              "Tempo de Descarga",
              "TMA",
              "Peso Bruto",
              "Gerente",
              "Valor",
              "Veiculo",
              "Janela Min.",
              "Janela Max.",
              "Ajuste Manual",
              "Usuário Ajuste",
              "Dia da semana da entrega",
              "Chegada dentro da certa",
              "Tipo Rota",
              "Data da criação da rota",
              "Data/Hora Ultima Chegada",
              "Campo Livre 1",
              "Campo Livre 2",
              "Início da rota", 
              "Finalização da rota", 
              "ETA Inicial", 
              "Tempo De Permanencia Previsto", 
              "Latitude Registro da Foto", 
              "Longitude Registro da Foto",
              "Distância entre Cliente e Registro da Foto", 
              "Distância Entre Cliente e Chegada", 
              "Latitude Chegada", 
              "Longitude Chegada", 
              "Qualidade", 
              "Chave do documento",
              "Distância Estimada"
          ],
          "campos_inclusos": [
              "Início de Viagem",
              "Início Pausa",
              "Fim Pausa",
              "Chegada",
              "Início de Descarga",
              "Fim de Descarga",
              "Registro da Foto",
              "Registro da Anotação",
              "Registro de Assinatura",
              "Fim da Entrega"
          ]
      }
  }
  

  Important

  • "fields" is used to define the names of the fields that should be used in the export. No fields should be added or removed, just changed.
  • The "fields" field must not have its order changed, however the name of the fields can be changed for export.
  • If the "fields" and "included_fields" fields are not passed, the system default determined by the support team will be used.
  • Some fields will not be sent by default because they require a lot of processing, even when passed in the parameters, due to the high level of processing required. If the field is really necessary, contact support to have it released to your user in question.
  • In "included_fields" it is possible to select which fields and in what order they will be exported, the field names must be the same as the "fields" field. If you want to export all fields, do not add "included_fields".
  • In "formato_exportação" it is possible to select which export model, the following are accepted: xml, xls, json and csv;

  Response Example

  • Success:

    {
        "statusCode": 200,
        "headers": {
            "Content-Type": "application/json",
            "Access-Control-Allow-Origin": "*",
            "Access-Control-Allow-Credentials": true
        },
        "body": {
            "user_message": "https://comprovei.s3.amazonaws.com/producao/report_requests/export/21/routeExport-20200525192526.csv.zip?  X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJELIIV2RATTMVK7A%2F20200525%2Fus-east-1%2Fs3%2Faws4_request&    X-Amz-Date=20200525T192538Z&X-Amz-Expires=259200&   X-Amz-Signature=19d54276cff1a3f1e074bac3e5f7737d670030f5bfb8267fbfebeb335a2dfca4&X-Amz-SignedHeaders=host",
            "code": 0,
            "internal_message": "Exportação gerada com sucesso!",
            "response_data": ""
        }
    }
    

  • Error:

    {
        "statusCode": 400,
        "headers": {
            "Content-Type": "application/json",
            "Access-Control-Allow-Origin": "*",
            "Access-Control-Allow-Credentials": true
        },
        "body": {
            "message": "Não foram encontrados resultados para os filtros selecionados!"
        }
    }
    

  • Error:

    {
        "statusCode": 400,
        "headers": {
            "Content-Type": "application/json",
            "Access-Control-Allow-Origin": "*",
            "Access-Control-Allow-Credentials": true
        },
        "body": {
            "message": "Algum campo de data está no formato errado. Tente (aaaa-mm-dd)"
        }
    }
    

    • Error:

      {
          "statusCode": 400,
          "headers": {
              "Content-Type": "application/json",
              "Access-Control-Allow-Origin": "*",
              "Access-Control-Allow-Credentials": true
          },
          "body": {
              "message": "O intervalo de datas não pode ter mais de 31 dias"
          }
      }