• Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Blog
  • Entrar
  • Cadastrar-se
  • Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Blog
  • Entrar
  • Cadastrar-se
home/APIs Privadas/Roteirização e Monitoramento (tmsentregas)/torrecontrole
Mais pesquisados:Customização, Tutorial, Documentação

torrecontrole

1 views 0 16/03/2022 Atualizado em 04/05/2022 integrador

2.0info: 1.3.0 torrecontrole description: Serviço Torre de Controle x-senior-domain: tmsentregas x-senior-domain-path: tmsentregas x-senior-service-path: torrecontrole contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/tmsentregassecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /torrecontrole/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/obterInformacaoVisaoGeralTorre: post: description: Obter informações visão geral da Torre Controle tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtrosTorre properties: filtrosTorre: type: object allOf: – #/definitions/filtrosTorre description: Filtros informacoes Torre de Controle responses: 200: description: Ok schema: type: object required: – informacaoVisaoGeralTorre properties: informacaoVisaoGeralTorre: type: object allOf: – #/definitions/recInformacaoVisaoGeralTorre description: Informação visão geral Torre de Controle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/obterInformacoesAtividadesPendentes: post: description: Obter informações atividades pendentes da Torre de Controle tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtrosTorre properties: filtrosTorre: type: object allOf: – #/definitions/filtrosTorre description: Filtros informações Torre de Controle responses: 200: description: Ok schema: type: object required: – atividadesPendentes properties: atividadesPendentes: type: object allOf: – #/definitions/recAtividadesPendentes description: Informacoes gerais atividades pendentes Torre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/obterInformacoesAtividadesConcluidas: post: description: Obter informações atividades concluídas da Torre de Controle tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtrosTorre properties: filtrosTorre: type: object allOf: – #/definitions/filtrosTorre description: Filtros informações responses: 200: description: Ok schema: type: object required: – atividadesConcluidas properties: atividadesConcluidas: type: object allOf: – #/definitions/recAtividadesConcluidas description: Atividades Concluídas Torre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/obterInformacoesDeViagens: post: description: Obter Informacoes de Viagens tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtrosTorre properties: filtrosTorre: type: object allOf: – #/definitions/filtrosTorre description: Fitros Torre responses: 200: description: Ok schema: type: object required: – viagens – registrosPorPagina – totalRegistros – qtdPaginas – pagina properties: viagens: type: array items: type: object allOf: – #/definitions/recViagem minimum: 1 description: Informações das viagens registrosPorPagina: type: integer format: int64 description: Quantidade de registros por página totalRegistros: type: integer format: int64 description: Total de registros encontrados qtdPaginas: type: integer format: int64 description: Total de páginas encontradas pagina: type: integer format: int64 description: Número da pagina 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/buscarParametroCentralAlerta: post: description: Buscar parametro de alerta na torre de controle tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – usuario properties: usuario: type: string description: Usuário de plataforma responses: 200: description: Ok schema: type: object required: – parametros properties: parametros: type: array items: type: object allOf: – #/definitions/recParametroCentralAlertaOutput minimum: 1 description: Retorno dos dados ativados dos paramêtros de alerta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Buscar parametro de alerta na torre de controle tags: – Queries x-senior-visibility: PRIVATE parameters: – name: usuario description: Usuário de plataforma in: query required: true type: string responses: 200: description: Ok schema: type: object required: – parametros properties: parametros: type: array items: type: object allOf: – #/definitions/recParametroCentralAlertaOutput minimum: 1 description: Retorno dos dados ativados dos paramêtros de alerta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/obterTotalVeiculosSituacaoEmViagens: post: description: Retorna o total de veículos por situação em viagem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpjFiliais – integridadeVeiculo properties: cnpjFiliais: type: array items: type: string minimum: 1 description: Filiais para filtro integridadeVeiculo: type: array items: type: string allOf: – #/definitions/integridadeVeiculo minimum: 1 description: Integridade dos veículos – Ativos, Inativos, Em manutenção responses: 200: description: Ok schema: type: object required: – qtdParado – qtdEmViagem – qtdEmAlerta – qtdEmAtraso – qtdTodasAtividadesConcluidas – totalVeiculos properties: qtdParado: type: integer format: int64 description: Quantidade de veícuos parados, sem viagens qtdEmViagem: type: integer format: int64 description: Quantidade de veículos em viagens no prazo qtdEmAlerta: type: integer format: int64 description: Quantidade de veículos em viagens com alerta qtdEmAtraso: type: integer format: int64 description: Quantidade de veículos com viagens com atraso qtdTodasAtividadesConcluidas: type: integer format: int64 description: Quantidade de veículos com todas as atividades concluídas (realizadas ou não realizadas) totalVeiculos: type: integer format: int64 description: Quantidade total de veículos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/obterVeiculosRastreamento: post: description: Retorna a lista de todos veículos, com as respectivas situações em viagens tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cnpjFiliais: type: array items: type: string description: CNPJ das filiais para filtro placas: type: array items: type: string description: Placas a serem consultadas responses: 200: description: Ok schema: type: object required: – veiculos properties: veiculos: type: array items: type: object allOf: – #/definitions/recVeiculo minimum: 1 description: Lista de veículos de resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de todos veículos, com as respectivas situações em viagens tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cnpjFiliais description: CNPJ das filiais para filtro in: query type: array items: type: string – name: placas description: Placas a serem consultadas in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – veiculos properties: veiculos: type: array items: type: object allOf: – #/definitions/recVeiculo minimum: 1 description: Lista de veículos de resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/obterPosicaoVeiculosRastreamento: post: description: Retorna a lista de posições de veículos, conforme operadora de rastreamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – placa properties: placa: type: string description: Veículo dataInicioPosicao: type: string format: date-time description: Período inicial do posicionamento – Padrão: dia atual a partir do primeiro horário (00:00) dataFimPosicao: type: string format: date-time description: Período final do posicionamento – Padrão: dia atual até o último horário (23:59) responses: 200: description: Ok schema: type: object required: – posicoes properties: posicoes: type: array items: type: object allOf: – #/definitions/recPosicaoVeiculoRastreadora minimum: 1 description: Resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de posições de veículos, conforme operadora de rastreamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: placa description: Veículo in: query required: true type: string – name: dataInicioPosicao description: Período inicial do posicionamento – Padrão: dia atual a partir do primeiro horário (00:00) in: query type: string format: date-time – name: dataFimPosicao description: Período final do posicionamento – Padrão: dia atual até o último horário (23:59) in: query type: string format: date-time responses: 200: description: Ok schema: type: object required: – posicoes properties: posicoes: type: array items: type: object allOf: – #/definitions/recPosicaoVeiculoRastreadora minimum: 1 description: Resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/obterPlacasVeiculosFiltroRastreamento: post: description: Retorna a lista de placas dos veículos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cnpjFiliais: type: array items: type: string description: CNPJ das filiais para filtro placas: type: array items: type: string description: Placas a serem consultadas responses: 200: description: Ok schema: type: object required: – placas properties: placas: type: array items: type: string minimum: 1 description: Lista de placas de resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de placas dos veículos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cnpjFiliais description: CNPJ das filiais para filtro in: query type: array items: type: string – name: placas description: Placas a serem consultadas in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – placas properties: placas: type: array items: type: string minimum: 1 description: Lista de placas de resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/obterPosicoesTrajetoPlanejado: post: description: Retorna a lista de posições planejadas / roteirizadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idViagem properties: idViagem: type: integer format: int64 description: Referencia da viagem idAtividade: type: integer format: int64 description: Referencia da atividade responses: 200: description: Ok schema: type: object required: – posicoes properties: posicoes: type: array items: type: object allOf: – #/definitions/recCoordenada minimum: 1 description: Posições encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de posições planejadas / roteirizadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idViagem description: Referencia da viagem in: query required: true type: integer format: int64 – name: idAtividade description: Referencia da atividade in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – posicoes properties: posicoes: type: array items: type: object allOf: – #/definitions/recCoordenada minimum: 1 description: Posições encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/obterPosicoesTrajetoExecutado: post: description: Retorna a lista de posições executadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idViagem properties: idViagem: type: integer format: int64 description: Referencia da viagem idAtividade: type: integer format: int64 description: Referencia da atividade responses: 200: description: Ok schema: type: object required: – posicoes properties: posicoes: type: array items: type: object allOf: – #/definitions/recCoordenada minimum: 1 description: Posições encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de posições executadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idViagem description: Referencia da viagem in: query required: true type: integer format: int64 – name: idAtividade description: Referencia da atividade in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – posicoes properties: posicoes: type: array items: type: object allOf: – #/definitions/recCoordenada minimum: 1 description: Posições encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/obterOcorrenciasAtividade: post: description: Retorna a lista de ocorrências lançadas em uma determinada atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idAtividade properties: idAtividade: type: integer format: int64 description: Chave da atividade responses: 200: description: Ok schema: type: object required: – ocorrencias properties: ocorrencias: type: array items: type: object allOf: – #/definitions/recOcorrencia minimum: 1 description: Ocorrências encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de ocorrências lançadas em uma determinada atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idAtividade description: Chave da atividade in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ocorrencias properties: ocorrencias: type: array items: type: object allOf: – #/definitions/recOcorrencia minimum: 1 description: Ocorrências encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportTorreControle: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportLocalizacaoVeiculo: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportParametroAlerta: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportAlertaAtividade: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportViagem: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportAtividade: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportAtividadeMovimento: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportOcorrencia: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportVeiculo: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportMotorista: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportFilial: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportVeiculoRastreadora: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportPosicaoVeiculoRastreadora: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportPosicaoPlanejada: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/exportGrauParentesco: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/ativarParametroCentralAlerta: post: description: Ativar parametro de alerta na torre de controle tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – usuario – parametros properties: usuario: type: string description: Usuário da plataforma parametros: type: array items: type: object allOf: – #/definitions/recParametroCentralAlertaInput minimum: 1 description: Dados de ativação do parametro central de alerta responses: 200: description: Ok schema: type: object properties: parametros: type: array items: type: object allOf: – #/definitions/recParametroCentralAlertaOutput description: Retorno dos dados ativados dos paramêtros de alerta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/buscarAlertaAtividadeProjection: post: description: Buscar parametro de alerta atividades tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipoAlerta properties: tipoAlerta: type: array items: type: string allOf: – #/definitions/tipoAlerta minimum: 1 description: Tipo de alerta idViagens: type: array items: type: integer format: int64 description: Id das viagens cujos alertas foram gerados filiais: type: array items: type: string description: CNPJ das filiais para consulta pagina: type: integer format: int64 description: Número da página atual de resultados default: 0 itensPorPagina: type: integer format: int64 description: Quantidade de itens por página de resultado default: 20 totalRegistros: type: integer format: int64 description: Total de alertas da consulta default: 0 motoristas: type: array items: type: integer format: int64 description: codigo do motorista placas: type: array items: type: string description: Número da placa responses: 200: description: Ok schema: type: object required: – totalRegistros – totalPaginas – itensPorPagina properties: alertaAtividade: type: array items: type: object allOf: – #/definitions/recAlertaAtividadeOutput description: Informações dos alertas da Torre de Controle totalRegistros: type: integer format: int64 description: Total de alertas da consulta totalPaginas: type: integer format: int64 description: Total de paginas de resultado itensPorPagina: type: integer format: int64 description: Quantidade de itens por página de resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/alterarSituacaoAlerta: post: description: Alterar a situação do alerta Ativo/Inativo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – alertas properties: alertas: type: array items: type: object allOf: – #/definitions/recAlteraSituacaoAlertaInput minimum: 1 description: Id dos alertas a serem alterados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/alterarAlertaLido: post: description: Alterar alerta para lido/não lido tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – alertas properties: alertas: type: array items: type: object allOf: – #/definitions/recAlteraAlertaLidoInput minimum: 1 description: Id dos alertas a serem alterados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/alterarSituacaoTodosAlertas: post: description: Altera a situação de todos os alertas conforme Filiais e tipos informados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpjFiliais – ativo properties: cnpjFiliais: type: array items: type: string minimum: 1 description: Lista de CNPJ das filiais tipoAlerta: type: array items: type: string allOf: – #/definitions/tipoAlerta description: Tipo de alerta ativo: type: boolean description: Ativo (true) / Inativo (false) responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/alterarTodosAlertasLidos: post: description: Altera todos os alertas conforme filiais e tipos informados para Lido / Não lido tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpjFiliais – lido properties: cnpjFiliais: type: array items: type: string minimum: 1 description: Lista de CNPJ das filiais tipoAlerta: type: array items: type: string allOf: – #/definitions/tipoAlerta description: Tipo de alerta lido: type: boolean description: Lido (true) / Não lido (false) responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importTorreControle: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importLocalizacaoVeiculo: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importParametroAlerta: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importAlertaAtividade: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importViagem: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importAtividade: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importAtividadeMovimento: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importOcorrencia: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importVeiculo: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importMotorista: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importFilial: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importVeiculoRastreadora: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importPosicaoVeiculoRastreadora: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importPosicaoPlanejada: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/actions/importGrauParentesco: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/torreControle: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/torreControle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/localizacaoVeiculo: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/localizacaoVeiculo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/parametroAlerta: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/parametroAlerta responses: 200: description: The created resource schema: #/definitions/parametroAlerta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/parametroAlerta responses: 200: description: The created resource schema: #/definitions/parametroAlerta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/parametroAlerta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/parametroAlerta/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/parametroAlerta responses: 200: description: Ok schema: #/definitions/parametroAlerta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/parametroAlerta responses: 200: description: Ok schema: #/definitions/parametroAlerta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/parametroAlerta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/parametroAlerta/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/parametroAlerta responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/alertaAtividade: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/alertaAtividade responses: 200: description: The created resource schema: #/definitions/alertaAtividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/alertaAtividade responses: 200: description: The created resource schema: #/definitions/alertaAtividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/alertaAtividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/alertaAtividade/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/alertaAtividade responses: 200: description: Ok schema: #/definitions/alertaAtividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/alertaAtividade responses: 200: description: Ok schema: #/definitions/alertaAtividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/alertaAtividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/alertaAtividade/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/alertaAtividade responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/viagem: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/viagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/atividade: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/atividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/atividadeMovimento: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/atividadeMovimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/ocorrencia: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/ocorrencia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/veiculo: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/veiculo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/motorista: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/motorista 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/filial: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/veiculoRastreadora: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/veiculoRastreadora 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/posicaoVeiculoRastreadora: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/posicaoVeiculoRastreadora 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/posicaoPlanejada: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/posicaoPlanejada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /torrecontrole/entities/grauParentesco: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/grauParentesco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: tipoAtividade: description: Tipo atividade type: string enum: – COLETA – ENTREGA – SERVICO tipoVeiculo: description: Enum tipo de veículo type: string enum: – MOTO – CARRO – VEICULO_URBANO_CARGA – TRUCK – TOCO – CARRETA – BITREM – CAVALO_MECANICO statusVeiculo: description: Enum status do veículo type: string enum: – VEICULO_EM_TRANSITO – VEICULO_PARADO – VEICULO_COLETANDO – VEICULO_ENTREGANDO – VEICULO_PRESTANDO_SERVICO integridadeVeiculo: description: Integridade do Veículo type: string enum: – VEICULO_ATIVO – VEICULO_MANUTENCAO – VEICULO_INATIVO tipoDocumento: description: Tipo do documento type: string enum: – PEDIDO – NFE – NFSE – CTE – PADRAO tipoImagem: description: Tipo de Imagem type: string enum: – URI – BASE64 situacaoAtividadeTorreControle: description: Status da atividade na Torre de Controle type: string enum: – PENDENTE_PRAZO – PENDENTE_ALERTA – PENDENTE_ATRASO – REALIZADA_PRAZO – REALIZADA_ATRASO – NAO_REALIZADA situacaoDispositivoTorreControle: description: Status da comunicação com o dispositivo type: string enum: – OFF_LINE – ON_LINE tipoAlerta: description: Tipo Alerta type: string enum: – ALERTA_ATIVIDADE_NAO_REALIZADA – ALERTA_ATIVIDADE_BAIXADA_FORA_DE_SEQUENCIA – ALERTA_ATIVIDADE_EM_ALERTA – ALERTA_ATIVIDADE_ATRASADA – ALERTA_ENTREGA_DEVOLVIDA situacaoVeiculoViagem: description: Situação do veículo em relação a viagens type: string enum: – NO_PRAZO – EM_ALERTA – EM_ATRASO – SEM_VIAGEM – TODAS_CONCLUIDAS situacaoViagemFiltro: description: Situações das viagens a serem utilizadas como filtro type: string enum: – ATIVIDADES_PENDENTES – ATIVIDADES_CONCLUIDAS serviceHealthStatus: description: Define o Status do serviço type: string enum: – UP – DOWN userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR filtrosTorre: description: Filtros para retorno das informações da torre de controle type: object required: – listaCnpjFilial – usuario properties: listaCnpjFilial: type: array items: type: string minimum: 1 description: Código identificador da filial cdAtividade: type: integer format: int64 description: Código específico de uma atividade para resultado usuario: type: string description: Usuário (completo, conforme login) responsável pela requisição placaVeiculo: type: array items: type: string description: Placa de veículo cdMotorista: type: array items: type: integer format: int64 description: Motorista vinculado as rotas situacaoAtividade: type: array items: type: string allOf: – #/definitions/situacaoAtividadeTorreControle description: Situação das atividades conforme regras da torre situacaoDispositivo: type: array items: type: string allOf: – #/definitions/situacaoDispositivoTorreControle description: Situação da comunicação com os dispositivos situacaoViagem: type: array items: type: string allOf: – #/definitions/situacaoViagemFiltro description: Situação das viagens registrosPorPagina: type: integer format: int64 description: Quantidade de registros por página totalRegistros: type: integer format: int64 description: Total de registros encontrados qtdPaginas: type: integer format: int64 description: Quantidade de Páginas de consulta pagina: type: integer format: int64 description: Número da página inicial idViagem: type: integer format: int64 description: Código específico de uma viagem para resultado pontosApoio: type: array items: type: integer format: int64 description: Código identificador do ponto de apoio recInformacaoVisaoGeralTorre: description: Informação Visão Geral Torre Controle type: object properties: totalAtividades: type: integer format: int64 description: Total de atividades default: 0 totalAtividadesPendentes: type: integer format: int64 description: Total de atividades pendentes default: 0 totalAtividadesConcluidas: type: integer format: int64 description: Total de atividades concluídas default: 0 recAtividadesPendentes: description: Informações gerais das atividades pendentes na Torre type: object required: – atividadesPendentesPrazo – atividadesPendentesEmAlerta – atividadesPendentesEmAtraso properties: percentualAtividadesPendentesNoPrazo: type: integer format: int64 description: Percentual de atividades pendentes no prazo default: 0 atividadesPendentesPrazo: type: object allOf: – #/definitions/recInformacoesAtividades description: Atividades pendentes no prazo atividadesPendentesEmAlerta: type: object allOf: – #/definitions/recInformacoesAtividades description: Atividades pendentes em alerta atividadesPendentesEmAtraso: type: object allOf: – #/definitions/recInformacoesAtividades description: Atividades pendentes em atraso recAtividadesConcluidas: description: Atividades Concluidas Torre type: object required: – atividadesConcluidasNoPrazo – atividadesConcluidasComAtraso – atividadesConcluidasNaoRealizadas properties: percentualAtividadesConcluidasNoPrazo: type: integer format: int64 description: Percentual de atividades concluidas no prazo default: 0 atividadesConcluidasNoPrazo: type: object allOf: – #/definitions/recInformacoesAtividades description: Atividades concluidas no prazo atividadesConcluidasComAtraso: type: object allOf: – #/definitions/recInformacoesAtividades description: Atividades concluídas com atraso atividadesConcluidasNaoRealizadas: type: object allOf: – #/definitions/recInformacoesAtividades description: Atividades concluídas não realizadas recInformacoesAtividades: description: Informações Atividades Pendentes Torre type: object required: – totalAtividades – situacaoAtividadeTorre properties: totalAtividades: type: number format: double description: Total atividades pendentes situacaoAtividadeTorre: type: string allOf: – #/definitions/situacaoAtividadeTorreControle description: Situação atividade Torre de Controle recViagem: description: Informação referente a viagem na torre type: object required: – id – filial – veiculo – atividades – tempoExecucaoEmMinutos – distanciaPercorridaEmKm properties: id: type: integer format: int64 description: Código da rota dataExecucao: type: string format: date-time description: Data execução da rota filial: type: object allOf: – #/definitions/recFilial description: Informações da Filial veiculo: type: object allOf: – #/definitions/recVeiculo description: Informação sobre o veículo atividades: type: array items: type: object allOf: – #/definitions/recAtividade minimum: 1 description: Lista das atividades de uma rota tempoExecucaoEmMinutos: type: integer format: int64 description: Informação do tempo de execução em minutos distanciaPercorridaEmKm: type: number format: double description: Informação da distância percorrida em KM pontoApoio: type: object allOf: – #/definitions/recPontoApoio description: Informação do ponto de apoio recFilial: description: Informações da empresa type: object required: – cnpj – nome – localizacao – matriz properties: cnpj: type: string description: CPNJ da empresa nome: type: string description: Nome da empresa localizacao: type: object allOf: – #/definitions/recCoordenada description: Localização da empresa matriz: type: boolean description: Indica se empresa é matriz ou filial recVeiculo: description: Informação do veículo type: object required: – tipo – filial – placa – motorista – status – integridade properties: tipo: type: string allOf: – #/definitions/tipoVeiculo description: Tipo de veículo filial: type: object allOf: – #/definitions/recFilial description: Informação da filial placa: type: string description: Número da placa do veículo motorista: type: object allOf: – #/definitions/recMotorista description: Informação do motorista status: type: string allOf: – #/definitions/statusVeiculo description: Status do veículo integridade: type: string allOf: – #/definitions/integridadeVeiculo description: Integridade do veículo posicao: type: object allOf: – #/definitions/recCoordenada description: Posição do veículo atualizacaoPosicao: type: string format: date-time description: Data de atualização da posição do veículo situacaoDispositivo: type: string description: Situação do dispositivo atualizacaoOcorrencia: type: string format: date-time description: Data de atualização da ocorrência idViagem: type: integer format: int64 description: Id da viagem / rota situacaoViagem: type: string allOf: – #/definitions/situacaoVeiculoViagem description: Situação do veículo em relação a viagens idRastreadora: type: integer format: int64 description: Id da rastreadora cujo veículo possui integração recAtividade: description: Informação das atividades para torre de controle type: object required: – id – tipo – filial – destino – documento – sequencia – peso – cubagem – volumes – tempoDistanciaPrevisto – tempoDistanciaRealizado – situacao properties: id: type: integer format: int64 description: Número identificador da atividade tipo: type: object allOf: – #/definitions/recTipoAtividade description: Tipo da Atividade [coleta – entrega – serviço] filial: type: object allOf: – #/definitions/recFilial description: Informação da Filial destino: type: object allOf: – #/definitions/recDestino description: Informação do destino da atividade documento: type: object allOf: – #/definitions/recDocumento description: Informação do documento vínculado a atividade [Pedido – NFE – NFSE – CTE – Padrao] sequencia: type: integer format: int64 description: Número da seqüência peso: type: number format: double description: Valor do peso cubagem: type: number format: double description: Valor da cubagem volumes: type: number format: double description: Valor do volume tempoDistanciaPrevisto: type: object allOf: – #/definitions/recTempoDistanciaAtendimento description: Tempo de distância prevista da atvidade tempoDistanciaRealizado: type: object allOf: – #/definitions/recTempoDistanciaAtendimento description: Tempo de distância realizada da atividade situacao: type: string allOf: – #/definitions/situacaoAtividadeTorreControle description: Situação da atividade previsaoAtendimento: type: string format: date-time description: Data da previsão de atendimento prazoAtendimento: type: string format: date-time description: Data do prazo de atendimento conclusao: type: string format: date-time description: Data de conclusão da atividade idViagem: type: integer format: int64 description: Número da identificação da rota ocorrencias: type: array items: type: object allOf: – #/definitions/recOcorrencia description: Informações das ocorrências da atividade situacaoDispositivo: type: string description: Situação do dispositivo recPontoApoio: description: Objeto do ponto de apoio type: object required: – localizacao properties: localizacao: type: object allOf: – #/definitions/recCoordenada description: Informação localização recCoordenada: description: Informação sobre coordenadas de locais type: object required: – latitude – longitude properties: latitude: type: string description: Informação de latitude de um local longitude: type: string description: Informação de longitude de umm local recMotorista: description: Informação do motorista type: object required: – codigo – cpf – nome – dispositivo properties: codigo: type: integer format: int64 description: Código do motorista cpf: type: string description: Código de pessoa física (CPF) nome: type: string description: Nome do motorista dispositivo: type: object allOf: – #/definitions/recDevice description: Dispositivo recTipoAtividade: description: Informação do tipo da atividade type: object required: – id – descricao properties: id: type: integer format: int64 description: Id do tipo da atividade descricao: type: string description: Descrição do tipo da atividade recDestino: description: Informação do destino da atividade type: object required: – descricao – cep – logradouro – numero – bairro – cidade – estado – pais – coordenada properties: descricao: type: string description: Descrição do destino da atividade cep: type: integer format: int64 description: Código de Endereçamento Postal logradouro: type: string description: Endereço de destino da atividade numero: type: integer format: int64 description: Número do destino bairro: type: string description: Bairro do destino cidade: type: string description: Cidade do destino estado: type: string description: Estado do destino pais: type: string description: País do destino coordenada: type: object allOf: – #/definitions/recCoordenada description: Coordenada do destino recDocumento: description: Informação do documento type: object required: – numero – tipo properties: numero: type: string description: Número do documento tipo: type: string allOf: – #/definitions/tipoDocumento description: Tipo do documento recTempoDistanciaAtendimento: description: Informação tempo distância do atendimento type: object required: – distanciaEmKm – tempoDeslocamentoEmMinutos – tempoAtendimentoEmMinutos properties: distanciaEmKm: type: number format: double description: Distância em KM tempoDeslocamentoEmMinutos: type: number format: double description: Tempo de deslocamento em minutos tempoAtendimentoEmMinutos: type: integer format: int64 description: Tempo de atendimento em minutos recOcorrencia: description: Informação da ocorrência da atividade type: object required: – id – sequencia – data – entregue – descricao – complemento – contato – motorista properties: id: type: integer format: int64 description: Número da identificação da atividade sequencia: type: integer format: int64 description: Número da seqüencia data: type: string format: date-time description: Data da ocorrência entregue: type: integer format: int64 description: Informação entregue ou não descricao: type: string description: Descrição da ocorrência complemento: type: string description: Complemento da ocorrência contato: type: object allOf: – #/definitions/recPessoa description: Contato da ocorrência motorista: type: object allOf: – #/definitions/recMotorista description: Motorista gerador da ocorrência comprovante: type: object allOf: – #/definitions/recImagem description: Imagem do comprovante assinatura: type: object allOf: – #/definitions/recImagem description: Assinatura do contato peso: type: number format: double description: Peso volume: type: number format: double description: Volume quantidade: type: integer format: int64 description: Quantidade hodometro: type: number format: double description: Hodometro coordenada: type: object allOf: – #/definitions/recCoordenada description: Coordenada grauParentesco: type: object allOf: – #/definitions/recGrauParentesco description: Informações sobre o Grau de parentesco do contato numeroResidencia: type: string description: Número do endereço caixaLacrada: type: boolean description: conferidoSemFalta: type: boolean description: idViagem: type: integer format: int64 description: Chave da viagem / rota / roteiro recDevice: description: Dispositivo type: object required: – id properties: id: type: string description: Identificação do dispositivo recPessoa: description: Informação da pessoa type: object required: – nome – documento – telefone properties: nome: type: string description: Nome pessoa documento: type: string description: Documento da pessoa telefone: type: string description: Telefone da pessoa recGrauParentesco: description: Informações de grau de parentesco do contato das ocorrências apontadas nas atividades type: object required: – idGrauParentesco – descricao properties: idGrauParentesco: type: integer format: int64 description: ID descricao: type: string description: Descrição recImagem: description: Imagem da ocorrência type: object required: – tipo properties: tipo: type: string allOf: – #/definitions/tipoImagem description: Tipo de imagem fonte: type: string description: Fonte recParametroCentralAlertaInput: description: Input parametro central alerta type: object required: – tipoAlerta – ativo properties: tipoAlerta: type: string allOf: – #/definitions/tipoAlerta description: Tipo alerta tempo: type: string format: date-time description: Tempo que o alerta será apresentado ativo: type: boolean description: Informa se o alerta está ativo recParametroCentralAlertaOutput: description: Output paramêtro central de alerta type: object required: – tipoAlerta – usuario – tempo – ativo properties: id: type: string description: Id referente ao registro de parametro da Central de Alerta tipoAlerta: type: string allOf: – #/definitions/tipoAlerta description: Tipo alerta usuario: type: string description: Usuário plataforma tempo: type: string format: date-time description: Tempo que o alerta será apresentado ativo: type: boolean description: Informa se o alerta está ativo recAlertaAtividadeOutput: description: Output dos alertas da atividade type: object required: – id – atividade – roteiro – tipoAlerta – titulo – descricao – ativo – data – lido properties: id: type: string description: Id do alerta da atividade atividade: type: integer format: int64 description: Atividade correspondente roteiro: type: integer format: int64 description: Código do roteiro tipoAlerta: type: string allOf: – #/definitions/tipoAlerta description: Tipo de alerta titulo: type: string description: Titulo do alerta descricao: type: string description: Descrição do alerta ativo: type: boolean description: Indica se alerta está ativo ou não data: type: string format: date-time description: Data em que o alerta foi gerado lido: type: boolean description: Indica se o alerta foi marcado como lido recAlteraSituacaoAlertaInput: description: Input para alteração de situação dos alertas type: object required: – idAlerta – ativo properties: idAlerta: type: string description: ID do alerta ativo: type: boolean description: Ativo = true recAlteraAlertaLidoInput: description: Input para alteração marcar o alerta como lido/não lido type: object required: – idAlerta – lido properties: idAlerta: type: string description: ID do alerta lido: type: boolean description: Lido = true recPosicaoVeiculoRastreadora: description: Output para posicionamento dos veículos por rastreadoras type: object required: – id – placaVeiculo – logradouro – cidade – uf – coordenada – dataPosicao – dataRecebimento – velocidade – kmPosicao properties: id: type: integer format: int64 description: Id do posicionamento recebido placaVeiculo: type: string description: Placa do veículo logradouro: type: string description: Endereço cidade: type: string description: Cidade uf: type: string description: Unidade Federativa – Estado coordenada: type: object allOf: – #/definitions/recCoordenada description: Coordenada dataPosicao: type: string format: date-time description: Data do posicionamento dataRecebimento: type: string format: date-time description: Data do recebimento do posicionamento velocidade: type: integer format: int64 description: Velocidade atual kmPosicao: type: integer format: int64 description: KM atual checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do healthcheck torreControle: description: Entidade referente a view (TORRECONTROLE) type: object required: – idAtividade – chaveAcesso – composicao – destino – embarcador – empresa – grupoveiculo – dispositivo – motorista – numero – ocorrencia – operacao – roteirizacao – roteiro – sequencia – tipoCarga – versaoApp – cepFilial – cepPontoApoio – cidadePontoApoio – cnhMotorista – complementoPontoApoio – cpfMotorista – bairro – cidade – complemento – complementoOcorrencia – contato – destinatario – estado – descricaoFilial – latitude – localidade – longitude – motivo – numeroDocumento – observacao – descricaoOcorrencia – pais – referencia – descricaoTipoAtividade – usuario – veiculo – dataAgendamento – dataCalculoPedagio – dataDigitacao – dataExecucao – dataInclusao – dataInicio – dataJanelaFim – dataJanelaInicio – dataMovimento – dataPosicaoInicial – dataPrazoEntrega – dataPrevisaoChegada – dataPrevisaoEntrega – dataPrevisaoTermino – dataRealizado – dataTermino – enderecoFilial – hodometro – horaAtualizacao – horaIntervaloFim – horaIntervaloInicio – horaLimite – horaTrabalhoFim – horaTrabalhoInicio – idPontoapoio – alterado – alteradoEmExecucao – anexoComprovanteEntregaDigital – tipoAtividade – tipoDocumento – domingoUtil – exibeContatoTelefone – exigeDadosComplementares – exigeObservacao – incluiPosterior – liberaAtividadeFase – liberaAtividadeNovaRoteirizacao – prioridade – quartaUtil – quintaUtil – sabadoUtil – segundaUtil – sextaUtil – sincronizado – solicitaAssinaturaMob – status – tercaUtil – tipoFilial – tipoOcorrencia – kmRota – latitudeFilial – latitudeOcorrencia – latitudePontoApoio – latitudeVeiculo – longitudeFilial – longitudeOcorrencia – longitudePontoApoio – longitudeVeiculo – metrosCubicosRota – nomeMotorista – nomePontoApoio – numeroCep – numeroCnpjFilial – numeroDocumentoIdentificacaoPessoal – numeroTelefoneContato – numeroPlaca – numeroPlaca2 – numeroPlaca3 – numeroPlaca4 – numeroTelefoneContatoAtividade – numeroPontoApoio – ocorrenciaAtiva – paisPontoApoio – pesoOcorrencia – previsaoEntregaRota – quantidadeAtividades – quilometragem – quilometragemPercorrido – metrosCubicos – peso – pesoChegada – pesoRota – tempoAlertaAtraso – tempoAtendimento – tempoEstimado – tempoExecucaoAtividadeAtendimento – tempoExecucaoAtividadeTransito – tipoVeiculo – volume – quantidadeOcorrencia – regiaoVeiculo – retornaParaOrigem – rgMotorista – ruaPontoApoio – sequenciaAtividade – sequenciaOcorrencia – situacaoAtividade – situacaoDispositivo – situacaoOcorrencia – situacaorota – situacaoveiculo – telefoneFilial – telefoneMotorista – tempoEstimadoRota – ufPontoApoio – usuarioPlataforma – valorPedagio – volumeOcorrencia – volumesRota – apelidoOcorrencia – bairroPontoApoio – idRastreadora properties: idAtividade: type: integer format: int64 description: Id da atividade (mceatv.cdatividade) chaveAcesso: type: string description: Informação chave de acesso (mceatv.cdchaveacesso) composicao: type: integer format: int64 description: Informação código composição (mceatv.cdcomposicao) destino: type: string description: Informação código destino (mceatv.cddestino) embarcador: type: string description: Informação código embarcador (mceatv.cdembarcador) empresa: type: integer format: int64 description: Informação código empresa (mceempfl.cdempresa) grupoveiculo: type: integer format: int64 description: Informação código grupo veículo (mcerot.cdgrupoveiculo) dispositivo: type: integer format: int64 description: Informação código identificador dispositivo (mceatvmv.cdidentdisp) motorista: type: integer format: int64 description: Informação código motorista (mcerot.cdmotorista) numero: type: integer format: int64 description: Informação código número endereço (mceatv.cdnumero) ocorrencia: type: integer format: int64 description: Informação código ocorrência (mceatvmv.cdocorrencia) operacao: type: integer format: int64 description: Informação código operação (mceatv.cdoperacao) roteirizacao: type: integer format: int64 description: Informação código roteirização (mcerot.cdroteirizacao) roteiro: type: integer format: int64 description: Informação código roteiro (mcerotat.cdroteiro) sequencia: type: integer format: int64 description: Informação código sequência (mceatvmv.cdsequencia) tipoCarga: type: integer format: int64 description: Informação código tipo carga (mceatv.cdtipocarga) versaoApp: type: integer format: int64 description: Informação código versão app (mceatvmv.cdversaoapp) cepFilial: type: integer format: int64 description: Informação número cep filia (mceempfl.nrcep = cepfilial) cepPontoApoio: type: integer format: int64 description: Informação número cep ponto apoio (pontoapoio.nrcep = ceppontoapoio) cidadePontoApoio: type: string description: Informação cidade ponto de apoio (pontoapoio.dscidade = cidadepontoapoio) cnhMotorista: type: string description: Informação número carteira nacional de habilitação (mcemot.nrcnh = cnhmotorista) complementoPontoApoio: type: string description: Informação complemento do ponto apoio (dscomplemento = complementopontoapoio) cpfMotorista: type: string description: Informação cpf motorista (mcemot.nrcpf = cpfmotorista) bairro: type: string description: Informação nome bairro (mceatv.dsbairro) cidade: type: string description: Informação nome cidade (mceatv.dscidade) complemento: type: string description: Informação de complemento (mceatv.dscomplemento) complementoOcorrencia: type: string description: Informação complemento da ocorrência (mceatvmv.dscomplementoocorr) contato: type: string description: Informação referente contato (mceatvmv.dscontato) destinatario: type: string description: Informação referente destinatario (mceatv.dsdestinatario) estado: type: string description: Informação nome estado (mceatv.dsestado) descricaoFilial: type: string description: Informação nome filial (mceempfl.dsfilial) latitude: type: string description: Informação de latidade (mceatv.dslat) localidade: type: string description: Informação de localidade (mceatv.dslocal) longitude: type: string description: Informação de longitude (mceatv.dslong) motivo: type: string description: Informação referente motivo (mceatv.dsmotivo) numeroDocumento: type: string description: Informação referente número documento (mceatv.dsnrdocto) observacao: type: string description: Informação referente descrição observacao (mceatv.dsobservacao) descricaoOcorrencia: type: string description: Informação referene descrição ocorrência (mceocr.dsocorrencia) pais: type: string description: Informação referente descrição país (mceatv.dspais) referencia: type: string description: Informação descrição referencia (mcerot.dsreferencia) descricaoTipoAtividade: type: string description: Informação descrição tipo atividade (dstipoatividade) usuario: type: string description: Informação descrição usuário (mceatvmv.dsusuario) veiculo: type: string description: Informação descrição de veículo (mcevei.dsveiculo) dataAgendamento: type: string format: date-time description: Data agendamento atividade (mceatv.dtagendamento) dataCalculoPedagio: type: string format: date-time description: Data calculo pedagio (mcerot.dtcalculopedagio) dataDigitacao: type: string format: date-time description: Data digitação movimento atividade (mceatvmv.dtdigitacao) dataExecucao: type: string format: date-time description: Data execução da rota (mcerot.dtexecucao) dataInclusao: type: string format: date-time description: Data inclusão da atividade (mceatv.dtinclusao) dataInicio: type: string format: date-time description: Data de inicio (mcerot.dtinicio) dataJanelaFim: type: string format: date-time description: Data janela fim da atividade (mceatv.dtjanelafim) dataJanelaInicio: type: string format: date-time description: Data janela inicio da atividade (mceatv.dtjanelaini) dataMovimento: type: string format: date-time description: Data do movimento atividade movimento (mceatvmv.dtmovimento) dataPosicaoInicial: type: string format: date-time description: Data posição inicial atividade movimento (mceatvmv.dtposini) dataPrazoEntrega: type: string format: date-time description: Data prazo entrega atividade (mceatv.dtprazoentr) dataPrevisaoChegada: type: string format: date-time description: Data previsão chegada rota atividade (mcerotat.dtprevchegada) dataPrevisaoEntrega: type: string format: date-time description: Data previsão entrega atividade(mceatv.dtpreventr) dataPrevisaoTermino: type: string format: date-time description: Data de previsão de término da rota (mcerot.dtprevtermino) dataRealizado: type: string format: date-time description: Data atividade realizada (mceatv.dtrealizado) dataTermino: type: string format: date-time description: Data término da rota (mcerot.dttermino) enderecoFilial: type: string description: Informação endereço filial (mceempfl.dsendereco = enderecofilial) hodometro: type: number format: double description: Informação hodomentro veículo (mceatvmv.hodometro) horaAtualizacao: type: string format: date-time description: Informação hora atualização do veículo (mcevei.hratualizacao) horaIntervaloFim: type: string format: date-time description: Informação hora intervalo fim da rota (mcerot.hrintervalofim) horaIntervaloInicio: type: string format: date-time description: Informação hora intervalo inicio da rota (mcerot.hrintervaloini) horaLimite: type: string format: date-time description: Informação hora limite atividade (mceatv.hrlimite) horaTrabalhoFim: type: string format: date-time description: Informação hora fim trabalho rota (mcerot.hrtrabalhofim) horaTrabalhoInicio: type: string format: date-time description: Informação hora inicio trabalho rota(mcerot.hrtrabalhoini) idPontoapoio: type: integer format: int64 description: Id do ponto de apoio (mceatv.idpontoapoio) alterado: type: integer format: int64 description: Indicador rota alterada (mcerot.inalterado) alteradoEmExecucao: type: integer format: int64 description: Indicador rota alterada em execução (mcerot.inalteradoemexecucao) anexoComprovanteEntregaDigital: type: integer format: int64 description: Indicador anexo comprovante entrega digital (mceocr.inanexcomprentrdigit) tipoAtividade: type: integer format: int64 description: Indicador tipo atividade tipo atividade (mceatv.inatividade) tipoDocumento: type: integer format: int64 description: Indicador tipo documento (mceatv.indocto) domingoUtil: type: integer format: int64 description: Indicador domingo é dia util (mceempfl.indomingoutil) exibeContatoTelefone: type: integer format: int64 description: Indicador exibe contato telefone (mceempfl.inexibecontatofone) exigeDadosComplementares: type: integer format: int64 description: Indicador exige dados complementares (mceocr.inexigedadoscomplementares) exigeObservacao: type: integer format: int64 description: Indicador exige observação (mceocr.inexigeobs) incluiPosterior: type: integer format: int64 description: Indicador inclui posterior (mcerotat.inincposterior) liberaAtividadeFase: type: integer format: int64 description: Indicador libera atividade fase (mceocr.inlibatvfase) liberaAtividadeNovaRoteirizacao: type: integer format: int64 description: Indicador libera atividade nova roteirização (mceocr.inlibatvnovaroteirizacao) prioridade: type: integer format: int64 description: Indicador prioridade (mceatv.inprioridade) quartaUtil: type: integer format: int64 description: Indicador quarta-feira dia util (mceempfl.inquartautil) quintaUtil: type: integer format: int64 description: Indicador quinta-feira dia util (mceempfl.inquintautil) sabadoUtil: type: integer format: int64 description: Indicador sábado dia util (mceempfl.insabadoutil) segundaUtil: type: integer format: int64 description: Indicador segunda-feira dia util (mceempfl.insegundautil) sextaUtil: type: integer format: int64 description: Indicador sexta-feira dia util (mceempfl.insextautil) sincronizado: type: integer format: int64 description: Indicador atividade sincronizada (mceatvmv.insincronizado) solicitaAssinaturaMob: type: integer format: int64 description: Indicador solicita assinatura mob (mceocr.insolicassinaturamob) status: type: integer format: int64 description: Indicador status atividade mceatv.instatus tercaUtil: type: integer format: int64 description: Indicador terça-feira dia util (mceempfl.intercautil) tipoFilial: type: integer format: int64 description: Indicador tipo de filial (mceempfl.intpfilial) tipoOcorrencia: type: integer format: int64 description: Indicador tipo ocorrencia (mceocr.intpocorrencia) kmRota: type: integer format: int64 description: Quantidade quilometragem rota (mcerot.qtkm = kmrota) latitudeFilial: type: string description: Informação de latitude filial (mceempfl.dslatitude = latitudeFilial) latitudeOcorrencia: type: string description: Informação de latitude atividade movimento (mceatvmv.dslatitude = latitudeocorrencia) latitudePontoApoio: type: number format: double description: Informação de latitude ponto de apoio (pontoapoio.latitude = latitudepontoapoio) latitudeVeiculo: type: string description: Informação de latitude de veículo (mcevei.dslatitude = latitudeveiculo) longitudeFilial: type: string description: Informação de longitude filial (mceempfl.dslongitude = longitudefilial) longitudeOcorrencia: type: string description: Informação de longitude atividade movimento (mceatvmv.dslongitude = longitudeocorrencia) longitudePontoApoio: type: number format: double description: Informação de longitude ponto apoio (pontoapoio.longitude = longitudepontoapoio) longitudeVeiculo: type: string description: Informação de longitude do veículo (mcevei.dslongitude = longitudeveiculo) metrosCubicosRota: type: number format: double description: Informação de metros cubicos da rota (mcerot.qtmetroscubicos = metroscubicosrota) nomeMotorista: type: string description: Informação nome do motorista (mcemot.dsnome = nomemotorista) nomePontoApoio: type: string description: Informação nome ponto apoio (pontoapoio.nomepontoapoio = nomepontoapoio) numeroCep: type: integer format: int64 description: Informação cep atividade (mcatv.nrcep = nrcep) numeroCnpjFilial: type: string description: Informação número cnpj filial (mceatv.nrcnpjfilial = nrcnpjfilial) numeroDocumentoIdentificacaoPessoal: type: string description: Informação número documento identificação pessoal atividade movimento (mceatvmv.nrdoctoidentpessoal = nrdoctoidentpessoal) numeroTelefoneContato: type: string description: Informação número telefone contato atividade movimento (mceatvmv.nrfonecontato = nrfonecontato) numeroPlaca: type: string description: Informação número da placa do veículo rota (mcerot.nrplaca = nrplaca) numeroPlaca2: type: string description: Informação número da placa 2 do veículo rota (mcerot.nrplaca2 = nrplaca2) numeroPlaca3: type: string description: Informação número da placa 3 do veículo rota (mcerot.nrplaca3 = nrplaca3) numeroPlaca4: type: string description: Informação número da placa 4 do veículo rota (mcerot.nrplaca4 = nrplaca4) numeroTelefoneContatoAtividade: type: string description: Informação número telefone contato atividade (mceatv.nrtelefonecontato = nrtelefonecontato) numeroPontoApoio: type: integer format: int64 description: Informação número endereço ponto apoio (pontoapoio.numero = numeropontoapoio) ocorrenciaAtiva: type: integer format: int64 description: Indicador ocorrência ativa (mceocr.inativo = ocorrenciaativa) paisPontoApoio: type: string description: Informação país do ponto apoio (pontoapoio.dspais = paispontoapoio) pesoOcorrencia: type: number format: double description: Informação do peso atividade movimento (mceatvmv.peso = pesoocorrencia) previsaoEntregaRota: type: string format: date-time description: Informação data previsão entrega rota (mcerot.dtpreventr = preventrrota) quantidadeAtividades: type: number format: double description: Informação de quantidade atividades em uma rota (mcerot.qtatividades = qtatividades) quilometragem: type: number format: double description: Informação de quilometragem rota atividade (mcerotat.qtkm = qtkm) quilometragemPercorrido: type: number format: double description: Informação de quilometragem percorrida atividade movimento (mceatvmv.qtkmpercorrido = qtkmpercorrido) metrosCubicos: type: number format: double description: Informação metros cubicos na atividade (mceatv.qtmetroscubicos = qtmetroscubicos) peso: type: number format: double description: Informação de peso na atividade (mceatv.qtpeso = qtpeso) pesoChegada: type: number format: double description: Informação peso chegada atividade movimento (mceatvmv.qtpesochegada = qtpesochegada) pesoRota: type: number format: double description: Informação peso rota (mcerot.qtpeso = qtpesorota) tempoAlertaAtraso: type: string format: date-time description: Informação tempo alerta atividade em atraso (mcedef.qttempoalertaatraso = qttempoalertaatraso) tempoAtendimento: type: string format: date-time description: Informação tempo de atendimento da atividade (mceatv.qttempoatend = qttempoatend) tempoEstimado: type: number format: double description: Informação de tempo estimado rota para atividade (mcerotat.qttempoestimado = qttempoestimado) tempoExecucaoAtividadeAtendimento: type: number format: double description: Informação tempo executado para atendimento de uma atividade (mceatvmv.qttempoexecatvatendimento = qttempoexecatvatendimento) tempoExecucaoAtividadeTransito: type: number format: double description: Informação tempo execução atividade em transito (mceatvmv.qttempoexecatvtransito = qttempoexecatvtransito) tipoVeiculo: type: integer format: int64 description: Tipo do veículo (mcegve.intpveiculo) volume: type: number format: double description: Informação de volume de uma atividade (mceatv.qtvolume = qtvolume) quantidadeOcorrencia: type: integer format: int64 description: Informação quantidade de ocorrencias (mceatvmv.quantidade = quantidadeocorrencia) regiaoVeiculo: type: string description: Informação de regiao de atendimento do veículo (mcevei.dsregiaoatend = regiaoveiculo) retornaParaOrigem: type: boolean description: Indicador se o veículo retorna para origem (mcerot.retornaparaorigem) rgMotorista: type: string description: Informação do registro do geral do motorista (mcemot.nrrg = rgmotorista) ruaPontoApoio: type: string description: Informação rua ponto apoio (pontoapoio.dslogradouro = ruapontoapoio) sequenciaAtividade: type: integer format: int64 description: Informação de sequencia rota atividade(mcerotat.cdsequencia = seqatividade) sequenciaOcorrencia: type: integer format: int64 description: Informação de sequencia atividade movimento (mceatvmv.cdsequencia = seqocorrencia) situacaoAtividade: type: string description: Informação sobre situação da atividade (situacaoatividade) situacaoDispositivo: type: string description: Informação sobre situação do dispositivo (situacaodispositivo) situacaoOcorrencia: type: integer format: int64 description: Indicador situação da ocorrência (mceocr.insituacao = situacaoocorrencia) situacaorota: type: integer format: int64 description: Indicador situação da rota (mcerot.insituacao = situacaorota) situacaoveiculo: type: integer format: int64 description: Indicador situação do veículo (mcevei.insituacao = situacaoveiculo) telefoneFilial: type: string description: Informação telefone filial (mceempfl.nrtelefone = telefonefilial) telefoneMotorista: type: string description: Informação número telefone motorista (mcedsp.nrtelefone = telefonemotorista) tempoEstimadoRota: type: number format: double description: Informação de tempo estimado rota (mcerot.qttempoestimado = tempoestimadorota) ufPontoApoio: type: string description: Informação estado ponto de apoio (pontoapoio.dsestado = ufpontoapoio) usuarioPlataforma: type: string description: Informação usuario na plataforma (mcemot.usuarioplataforma = usuarioplataforma) valorPedagio: type: number format: double description: Informação valor de pedagio da rota (mcerot.vlpedagio = vlpedagio) volumeOcorrencia: type: integer format: int64 description: Informação volume atividade movimento (mceatvmv.volume = volumeocorrencia) volumesRota: type: integer format: int64 description: Informação de volume da rota (mcerot.qtvolumes = volumesrota) apelidoOcorrencia: type: string description: Informação de apelido da ocorrência (mceocr.dsapelido = apelidoocorrencia) bairroPontoApoio: type: string description: Informação de bairro do ponto de apoio (pontoapoio.dsbairro = bairropontoapoio) idRastreadora: type: integer format: int64 description: Id da rastreadora cujo veículo possui integração de posicionamento localizacaoVeiculo: description: Entidade referente a localização do veículo (SISLOCVE) type: object required: – sequencia – numeroPlaca properties: sequencia: type: integer format: int64 description: Número de sequência da localização do veículo (SISLOCVE.CdSequencia) numeroPlaca: type: string description: Número da placa de veículo (SISLOCVE.nrPlaca) horaAtualizacao: type: string format: date-time description: Hora de atualização do veículo (SISLOCVE.HrAtualizacao) horaRecepcao: type: string format: date-time description: Hora de recepção do veículo (SISLOCVE.HrRecepcao) situacaoVeiculo: type: integer format: int64 description: Indicador situação do veículo (SISLOCVE.InSituacaoVeiculo) latitude: type: number format: double description: Posição de latitude do veículo (SISLOCVE.DsLatitude) longitude: type: number format: double description: Posição de latitude do veículo (SISLOCVE.DsLongitude) empresa: type: integer format: int64 description: Código da empresa (SISLOCVE.CdEmpresa) quilometragemPercorrido: type: number format: double description: Quilometragem percorrido do veículo (SISLOCVE.QtKmPercorrido) localizacao: type: string description: Localização do veículo (SISLOCVE.DsLocalizacao) versaoApp: type: integer format: int64 description: Código da versão do aplicativo (SISLOCVE.CdVersaoApp) roteiro: type: integer format: int64 description: Código do roteiro (SISLOCVE.CdRoteiro) atividade: type: integer format: int64 description: Código da atividade (SISLOCVE.CdAtividade) parametroAlerta: description: Entidade referente aos parâmetros da central de alerta (ParametroAlerta) type: object required: – id – tipoAlerta – usuario – ativo properties: id: type: string description: Id do parâmetro da central de alerta tipoAlerta: type: string allOf: – #/definitions/tipoAlerta description: Tipo de alerta usuario: type: string description: Usuario da plataforma tempo: type: string format: date-time description: Tempo que o alerta será apresentado ativo: type: boolean description: Informa se o alerta está ativo alertaAtividade: description: Entidade referente aos alertas da central de alerta (AlertaAtividade) type: object required: – id – atividade – roteiro – tipoAlerta – titulo – descricao – data – ativo – lido – motorista – placa properties: id: type: string description: Id do alerta atividade: type: integer format: int64 description: Código da atividade roteiro: type: integer format: int64 description: Código do roteiro tipoAlerta: type: string allOf: – #/definitions/tipoAlerta description: Tipo de alerta titulo: type: string description: Titulo do alerta descricao: type: string description: Descrição do alerta data: type: string format: date-time description: Data de criação de alerta ativo: type: boolean description: Indica se alerta está ativo ou não lido: type: boolean description: Indica se o alerta foi marcado como lido motorista: type: integer format: int64 description: codigo do motorista placa: type: string description: Número da placa viagem: description: Entidade Rotas / Viagens type: object required: – id – cnpjFilial properties: id: type: integer format: int64 description: Id da viagem (CdRoteiro) cnpjFilial: type: string description: CNPJ da filial cuja rota foi gerada (NrCNPJFilial) atividade: description: Entidade atividade (MCEATV) type: object required: – id – tipoAtividade properties: id: type: integer format: int64 description: Id da atividade (CdAtividade) tipoAtividade: type: integer format: int64 description: Tipo Atividade (InAtividade) atividadeMovimento: description: Entidade atividade movimento (MCEATVMV) type: object required: – id – idAtividade – complementoOcorrencia – idViagem – ocorrencia – dataMovimento – latitude – longitude – usuario – numeroDocumentoContato – telefoneContato – nomeContato – versaoAplicativo – peso – hodometro – volume – quantidade – numeroResidencia – caixaLacrada – conferidoSemFalta properties: id: type: integer format: int64 description: Id idAtividade: type: integer format: int64 description: Id atividade complementoOcorrencia: type: string description: Descrição do complemento da ocorrência (DsComplementoOcorr) idViagem: type: integer format: int64 description: Código do roteiro (CdRoteiro) ocorrencia: type: integer format: int64 description: Código da ocorrência (CdOcorrencia) dataMovimento: type: string format: date-time description: Data da movimentação latitude: type: string description: Coordenada longitude: type: string description: Coordenada usuario: type: string description: Usuário responsável pelo apontamento numeroDocumentoContato: type: string description: Documento do contato telefoneContato: type: string description: Telefone do contato nomeContato: type: string description: Nome do contato versaoAplicativo: type: integer format: int64 description: Versão do aplicativo utilizada para movimentação peso: type: number format: double description: Peso hodometro: type: number format: double description: Hodometro volume: type: number format: double description: Volume quantidade: type: integer format: int64 description: Quantidade grauParentesco: type: object allOf: – #/definitions/grauParentesco description: Grau de parentesco do contato numeroResidencia: type: string description: Número da residência caixaLacrada: type: boolean description: Caixa lacrada conferidoSemFalta: type: boolean description: Conferência ocorrencia: description: Entidade ocorrência (MCEOCR) type: object required: – id – descricao – situacao – tipo properties: id: type: integer format: int64 description: Id da ocorrência (CdOcorrencia) descricao: type: string description: Descrição da ocorrência (DsOcorrencia) situacao: type: integer format: int64 description: Indicador situação da ocorrência (InSituacao) tipo: type: integer format: int64 description: Indicador tipo ocorrência (InTpOcorrencia) veiculo: description: Entidade Veículo (MCEVEI) type: object required: – id – descricao – situacao – hrUltimaAtualizacao – latitude – longitude – cnpjFilial properties: id: type: string description: Placa descricao: type: string description: Descrição do veículo situacao: type: integer format: int64 description: Situação do veículo hrUltimaAtualizacao: type: string format: date-time description: Data e hora da última atualização recebida de posicionamento através do App latitude: type: string description: Latitude do último posicionamento recebido através do App longitude: type: string description: Longitude do último posicionamento recebido através do App cnpjFilial: type: string description: CNPJ da filial cujo veículo está vinculado motorista: type: object allOf: – #/definitions/motorista description: Motorista vinculado ao veículo motorista: description: Entidade Motoristas type: object required: – id – nome – cnh – cpf – rg – cnpjFilial – usuarioPlataforma properties: id: type: integer format: int64 description: Código do motorista nome: type: string description: Nome cnh: type: string description: CNH cpf: type: string description: CPF rg: type: string description: RG cnpjFilial: type: string description: CNPJ da filial de vinculo usuarioPlataforma: type: string description: Usuário do motorista na plataforma filial: description: Entidade Filial type: object required: – id – nome – tipo – latitude – longitude properties: id: type: string description: CNPJ nome: type: string description: Nome da filial tipo: type: integer format: int64 description: Matriz / Filial latitude: type: string description: Posicionamento da filial conforme endereço longitude: type: string description: Posicionamento da filial conforme endereço veiculoRastreadora: description: Entidade Veículo integrado por Operadoras de Rastreamento type: object required: – id – dataUltimaPosicao – latitude – longitude – idRastreadora properties: id: type: string description: Placa dataUltimaPosicao: type: string format: date-time description: Data do último posicionamento recebido latitude: type: string description: Latitude do último posicionamento recebido longitude: type: string description: Longitude do último posicionamento recebido idRastreadora: type: integer format: int64 description: Código da operadora de rastreamento posicaoVeiculoRastreadora: description: Entidade que detém os posicionamentos dos veículos integrados por Operadoras de Rastreamento type: object required: – id – placaVeiculo – logradouro – cidade – uf – latitude – longitude – dataPosicao – dataRecebimento – velocidade – kmPosicao properties: id: type: integer format: int64 description: Id do posicionamento recebido placaVeiculo: type: string description: Placa do veículo logradouro: type: string description: Endereço cidade: type: string description: Cidade uf: type: string description: Unidade Federativa – Estado latitude: type: string description: Coordenada longitude: type: string description: Coordenada dataPosicao: type: string format: date-time description: Data do posicionamento dataRecebimento: type: string format: date-time description: Data do recebimento do posicionamento velocidade: type: integer format: int64 description: Velocidade atual kmPosicao: type: integer format: int64 description: KM atual posicaoPlanejada: description: Entidade que detém os posicionamentos gerados pelo planejamento / roteirização type: object required: – id – sequencia – idViagem – idAtividade – latitude – longitude properties: id: type: integer format: int64 description: Id do posicionamento planejato pelo roteirizador sequencia: type: integer format: int64 description: Sequencia do posicionamento planejado idViagem: type: integer format: int64 description: Referência da viagem idAtividade: type: integer format: int64 description: Referência da atividade latitude: type: number format: double description: Latitude longitude: type: number format: double description: Longitude grauParentesco: description: Entidade que armazena os registros de grau de parentescos type: object required: – id – descricao properties: id: type: integer format: int64 description: Chave descricao: type: string description: Descrição notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Sim  Não
Leave A Comment Cancelar resposta

Você precisa fazer o login para publicar um comentário.

© 2022 Senior. Todos os direitos reservados.
Mais pesquisados:Customização, Tutorial, Documentação