Mais pesquisados:Customização, Tutorial, Documentação

torrecontrole

98 views 0 16/03/2022 Atualizado em 18/06/2025 integrador

2.0info: 5.0.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 /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 /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/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE 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: PRIVATE 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/events/alertaAtividadeEvent: post: description: Alerta Atividade Evento x-senior-event: true tags: – Events 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 alerta responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: tipoAtividade: type: string enum: – COLETA – ENTREGA – SERVICO description: Tipo atividade: * `COLETA` – Tipo de atividade coleta * `ENTREGA` – Tipo de atividade entrega * `SERVICO` – Tipo de atividade serviço tipoVeiculo: type: string enum: – MOTO – CARRO – VEICULO_URBANO_CARGA – TRUCK – TOCO – CARRETA – BITREM – CAVALO_MECANICO – BITRUCK – RODOTREM description: Enum tipo de veículo: * `MOTO` – Moto * `CARRO` – Carro * `VEICULO_URBANO_CARGA` – Veículo carga urbana * `TRUCK` – Truck * `TOCO` – Toco * `CARRETA` – Carreta * `BITREM` – Bitrem * `CAVALO_MECANICO` – Cavalo mecânico * `BITRUCK` – Bitruck * `RODOTREM` – Rodotrem statusVeiculo: type: string enum: – VEICULO_EM_TRANSITO – VEICULO_PARADO – VEICULO_COLETANDO – VEICULO_ENTREGANDO – VEICULO_PRESTANDO_SERVICO description: Enum status do veículo: * `VEICULO_EM_TRANSITO` – Veículo em trânsito * `VEICULO_PARADO` – Veículo parado * `VEICULO_COLETANDO` – Veículo coletando * `VEICULO_ENTREGANDO` – Veículo entregando * `VEICULO_PRESTANDO_SERVICO` – Veículo prestando serviço integridadeVeiculo: type: string enum: – VEICULO_ATIVO – VEICULO_MANUTENCAO – VEICULO_INATIVO description: Integridade do Veículo: * `VEICULO_ATIVO` – Veículo Ativo * `VEICULO_MANUTENCAO` – Veículo em manutenção * `VEICULO_INATIVO` – Veículo inativo tipoDocumento: type: string enum: – PEDIDO – NFE – NFSE – CTE – PADRAO description: Tipo do documento: * `PEDIDO` – Documento Pedido * `NFE` – Documento Nota Fiscal Eletrônica * `NFSE` – Documento Nota Fiscal Serviço Eletrônica * `CTE` – Documento Conhecimento de Transporte Eletrônico * `PADRAO` – Documento Padrão tipoImagem: type: string enum: – URI – BASE64 description: Tipo de Imagem: * `URI` – URI * `BASE64` – BASE64 situacaoAtividadeTorreControle: type: string enum: – PENDENTE_PRAZO – PENDENTE_ALERTA – PENDENTE_ATRASO – REALIZADA_PRAZO – REALIZADA_ATRASO – NAO_REALIZADA description: Status da atividade na Torre de Controle: * `PENDENTE_PRAZO` – Pendente no prazo * `PENDENTE_ALERTA` – Pendente em alerta * `PENDENTE_ATRASO` – Pendente em atraso * `REALIZADA_PRAZO` – Realizada no prazo * `REALIZADA_ATRASO` – Realizada com atraso * `NAO_REALIZADA` – Não realizada situacaoDispositivoTorreControle: type: string enum: – OFF_LINE – ON_LINE description: Status da comunicação com o dispositivo: * `OFF_LINE` – OFFLINE * `ON_LINE` – ONLINE tipoAlerta: type: string enum: – ALERTA_ATIVIDADE_NAO_REALIZADA – ALERTA_ATIVIDADE_BAIXADA_FORA_DE_SEQUENCIA – ALERTA_ATIVIDADE_EM_ALERTA – ALERTA_ATIVIDADE_ATRASADA – ALERTA_ENTREGA_DEVOLVIDA description: Tipo Alerta: * `ALERTA_ATIVIDADE_NAO_REALIZADA` – Alerta atividade não realizada * `ALERTA_ATIVIDADE_BAIXADA_FORA_DE_SEQUENCIA` – Alerta atividade baixada fora de sequência * `ALERTA_ATIVIDADE_EM_ALERTA` – Alerta atividade em alerta * `ALERTA_ATIVIDADE_ATRASADA` – Alerta atividade atrasada * `ALERTA_ENTREGA_DEVOLVIDA` – Alerta entrega devolvida situacaoVeiculoViagem: type: string enum: – NO_PRAZO – EM_ALERTA – EM_ATRASO – SEM_VIAGEM – TODAS_CONCLUIDAS description: Situação do veículo em relação a viagens: * `NO_PRAZO` – Veiculo com atividades no prazo * `EM_ALERTA` – Veículo com atividades em alerta * `EM_ATRASO` – Veículo com atividades em atraso * `SEM_VIAGEM` – Veículo sem viagem * `TODAS_CONCLUIDAS` – Veículo com todas as atividades concluídas situacaoViagemFiltro: type: string enum: – ATIVIDADES_PENDENTES – ATIVIDADES_CONCLUIDAS description: Situações das viagens a serem utilizadas como filtro: * `ATIVIDADES_PENDENTES` – Que contenham atividades pendentes * `ATIVIDADES_CONCLUIDAS` – Que contenham todas as atividades concluídas / realizadas serviceHealthStatus: type: string enum: – UP – DOWN description: Define o Status do serviço: * `UP` – Up * `DOWN` – Down userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text 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 origem: type: object allOf: – #/definitions/recOrigem description: Informações de origem recOrigem: description: Informações de origem type: object required: – endereco – descricao – localizacao properties: endereco: type: string description: Endereco da origem descricao: type: string description: Descricao da origem localizacao: type: object allOf: – #/definitions/recCoordenada description: Localização 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 properties: id: type: string description: Id do dispositivo do motorista numeroTelefone: type: string description: Telefone motorista 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 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. 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 enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação