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

atividades

2746 views 1 07/11/2018 Atualizado em 16/10/2024 integrador

2.0info: 4.8.3 atividades description: Serviço Oracle RMS x-senior-domain: tmsentregas x-senior-domain-path: tmsentregas x-senior-service-path: atividades 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: /atividades/queries/buscaRegioes: post: description: Pesquisa de Regiões tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRegiaoIni: type: integer format: int64 description: Código identificador da Região cdRegiaoFin: type: integer format: int64 description: Código identificador da Região dsDescricao: type: string description: Descrição da Região cdReferencia: type: string description: Campo alfanumérico para refência do código no sistema legado inStatus: type: integer format: int64 description: Status da Região. Ex: Ativo/Inativo inTipo: type: integer format: int64 description: Tipo da região cadastrada. Ex: Por Endereço/ Por Mapa inBuscaDepEnderecos: type: boolean description: Se traz ou não os enderços vinculados default: true nrCNPJFilial: type: string description: CNPJ da filial indicaCidade: type: boolean description: Indica se a região foi criada automaticamente pelo serviço para indicar o local de uma cidade default: false responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEREGRec minimum: 1 description: Lista de Regiões 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Regiões tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRegiaoIni description: Código identificador da Região in: query type: integer format: int64 – name: cdRegiaoFin description: Código identificador da Região in: query type: integer format: int64 – name: dsDescricao description: Descrição da Região in: query type: string – name: cdReferencia description: Campo alfanumérico para refência do código no sistema legado in: query type: string – name: inStatus description: Status da Região. Ex: Ativo/Inativo in: query type: integer format: int64 – name: inTipo description: Tipo da região cadastrada. Ex: Por Endereço/ Por Mapa in: query type: integer format: int64 – name: inBuscaDepEnderecos description: Se traz ou não os enderços vinculados in: query type: boolean – name: nrCNPJFilial description: CNPJ da filial in: query type: string – name: indicaCidade description: Indica se a região foi criada automaticamente pelo serviço para indicar o local de uma cidade in: query type: boolean responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEREGRec minimum: 1 description: Lista de Regiões 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaRegioesAtividade: post: description: Pesquisa de Regiões por Atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade properties: cdAtividade: type: integer format: int64 description: Código da atividade responses: 200: description: Ok schema: type: object required: – regioes properties: regioes: type: array items: type: object allOf: – #/definitions/recRegiaoDescricao minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Regiões por Atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdAtividade description: Código da atividade in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – regioes properties: regioes: type: array items: type: object allOf: – #/definitions/recRegiaoDescricao minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaRegioesFilial: post: description: Pesquisa de Regiões por Filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial properties: nrCNPJFilial: type: string description: CNPJ da filial responses: 200: description: Ok schema: type: object required: – regioes properties: regioes: type: array items: type: object allOf: – #/definitions/recRegiaoDescricao minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Regiões por Filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: CNPJ da filial in: query required: true type: string responses: 200: description: Ok schema: type: object required: – regioes properties: regioes: type: array items: type: object allOf: – #/definitions/recRegiaoDescricao minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaTiposRegiao: post: description: Lista Código-Descrição de Tipos de Regiã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: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/inTipoRegRec minimum: 1 description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista Código-Descrição de Tipos de Região tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/inTipoRegRec minimum: 1 description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaStatusRegiao: post: description: Lista Código-Descrição de Status da Regiã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: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/inStatusRegRec minimum: 1 description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista Código-Descrição de Status da Região tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/inStatusRegRec minimum: 1 description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaTiposEndRegiao: post: description: Lista Código-Descrição de Tipos de Endereços da Regiã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: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/inTipoEndRegRec minimum: 1 description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista Código-Descrição de Tipos de Endereços da Região tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/inTipoEndRegRec minimum: 1 description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/importarMapaRegiao: post: description: Busca Coordenadas da Região tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRegiao: type: integer format: int64 description: Lista de código de regiões arquivo: type: string format: byte description: Arquivo KML em formato binário ou base64. responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEREGRec minimum: 1 description: Lista de polígonos inseridos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca Coordenadas da Região tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRegiao description: Lista de código de regiões in: query type: integer format: int64 – name: arquivo description: Arquivo KML em formato binário ou base64. in: query type: string format: byte responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEREGRec minimum: 1 description: Lista de polígonos inseridos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/consultaTicketIntegracao: post: description: Consulta o ticket gerado na integração de atividades: Recomendado para integrações. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: integer format: int64 description: Ticket utilizado na integração. responses: 200: description: Ok schema: type: object required: – status properties: status: type: integer format: int64 description: status da operação. 0 – Não encontrada importação, 1 – Processando, 2 – Processado Ok, 3 – Processado com erro ticket: type: integer format: int64 description: Ticket da importação, quando encontrado ok: type: boolean description: Boolean indicando se a operação teve sucesso na integração. cdRoteirizacao: type: integer format: int64 description: Código da roteirização gerada caso tenha sido informado os dados de rotas. cdRoteiros: type: array items: type: integer format: int64 description: Lista de roteiros. listaInseridas: type: array items: type: object allOf: – #/definitions/MCEATVRec description: Atividades que obtiveram êxito na operação. referenciasNaoInseridas: type: array items: type: string description: Lista de documentos de atividades enviadas, que não obtiveram êxito na operação. dsRefRoteiros: type: string description: Lista de referências de roteiros informados nas atividades da importação, separados por vírgula. Ex: 1-135-1,1-136-1 dsErro: type: string description: Descrição do erro ocorrido. DEPRECADO: utilizar variavel erros. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta o ticket gerado na integração de atividades: Recomendado para integrações. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ticket description: Ticket utilizado na integração. in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – status properties: status: type: integer format: int64 description: status da operação. 0 – Não encontrada importação, 1 – Processando, 2 – Processado Ok, 3 – Processado com erro ticket: type: integer format: int64 description: Ticket da importação, quando encontrado ok: type: boolean description: Boolean indicando se a operação teve sucesso na integração. cdRoteirizacao: type: integer format: int64 description: Código da roteirização gerada caso tenha sido informado os dados de rotas. cdRoteiros: type: array items: type: integer format: int64 description: Lista de roteiros. listaInseridas: type: array items: type: object allOf: – #/definitions/MCEATVRec description: Atividades que obtiveram êxito na operação. referenciasNaoInseridas: type: array items: type: string description: Lista de documentos de atividades enviadas, que não obtiveram êxito na operação. dsRefRoteiros: type: string description: Lista de referências de roteiros informados nas atividades da importação, separados por vírgula. Ex: 1-135-1,1-136-1 dsErro: type: string description: Descrição do erro ocorrido. DEPRECADO: utilizar variavel erros. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaAtividadesPainelAtividades: post: description: Pesquisa de Atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filiais: type: array items: type: string description: Lista com o CNPJ de filiais statusAtividade: type: string allOf: – #/definitions/situacaoAtividade description: Tipo de Situação dataInicialInicioRota: type: string format: date-time description: Data de início da rota dataFinalInicioRota: type: string format: date-time description: Data final da rota dataInclusaoAtividadeInicial: type: string format: date-time description: Data inicial de inclusão da atividade dataInclusaoAtividadeFinal: type: string format: date-time description: Data final de inclusão da atividade placas: type: array items: type: string description: Lista de placas cdMotoristas: type: array items: type: integer format: int64 description: Lista de códigos de motoristas dataPrazoEntrega: type: string format: date-time description: Data de prazo de entrega origemDestino: type: string description: Origem ou destino cdAtividade: type: integer format: int64 description: Código da atividade nrDocto: type: string description: Número do documento cdRoteiro: type: integer format: int64 description: Código da rota offset: type: integer format: int64 description: Página minimum: 0 default: 0 size: type: integer format: int64 description: Qtde por página minimum: 1 maximum: 100 default: 10 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/atividadesPainelRec minimum: 1 description: Lista Resultado totalItens: type: integer format: int64 description: Total de itens para a paginação pagina: type: integer format: int64 description: Página atual itensPorPagina: type: integer format: int64 description: Quantidade de itens por página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaAtividades: post: description: Pesquisa de Atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade properties: nrCNPJFilial: type: string description: Código identificador da filial filiais: type: array items: type: string description: Lista com o CNPJ de filiais cdAtividade: type: integer format: int64 description: Código identificador da atividade. Caso informado valor menor ou igual a zero, busca todas as atividades. atividades: type: array items: type: integer format: int64 description: Lista de Códigos identificador da atividade. inAtividade: type: integer format: int64 description: Tipo de atividade. Caso informado valor menor que zero, busca atividades de todos os tipos. nrPlaca: type: string description: Placa do veículo do roteiro vinculado a atividade. cdRoteiro: type: integer format: int64 description: Número do roteiro vinculado a atividade. listaRoteiros: type: array items: type: integer format: int64 description: Lista de roteiros vinculados as atividades dsNrDocto: type: string description: Número do documento (romaneio, nf, etc.) dtPrazoEntrega: type: string format: date-time description: Data Prazo de Entrega dtFinPrazoEntrega: type: string format: date-time description: Data Final Prazo de Entrega cdDestino: type: string description: Código Destino dsDestinatario: type: string description: Descrição do Destinatário inStatusRoteirizacao: type: integer format: int64 description: Status da atividade quanto a roteiros cdMotorista: type: integer format: int64 description: Código identificador do motorista listaRegioes: type: array items: type: integer format: int64 description: Filtro de Regiões. dtAgendamento: type: string format: date-time description: Data utilizada para apresentar ou não atividade durante seleção na roteirização listaStatus: type: array items: type: integer format: int64 description: Status de Aceite da atividade, onde não informado filtra todas, 0-Recusadas, 1-Em Análise, 2-Aceitas somenteDisponiveis: type: boolean description: Lista somente atividades não vinculadas a roteiros ou órfãs cdEmbarcador: type: string description: Código do Embarcador idPontoApoio: type: integer format: int64 description: Ponto de apoio da filial (caso a filial tenha) offset: type: integer format: int64 description: Página limit: type: integer format: int64 description: Qtde por página ordenacao: type: string allOf: – #/definitions/ordenacao description: Ordem Ex.: ASC, DESC campoOrdenacao: type: string allOf: – #/definitions/buscaAtividadesOrdenacao description: Campo de ordenação Ex.: cdAtividade, dtPrazoEntr carregarTodosRoteiros: type: boolean description: Lista todas as atividades de acordo com o roteiro – se for null é setado automáticamente para true, se for false vai pegar a última atividade do roteiro. Exemplo: Atividade 1 – Rota 1; Atividade 1 – Rota 2; resultado – Atividade 1 – Rota 2; default: true carregarDadosOperacao: type: boolean description: Retorna todos os dados da operação default: false carregarDadosTipoCarga: type: boolean description: Retorna todos os dados do tipo de carga default: false somenteDistribuicao: type: boolean description: Retorna as atividades de entregas, coletas e serviços, que não sejam realcionadas a carga fechada / lotação responses: 200: description: Ok schema: type: object required: – atividades properties: atividades: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista de Atividades totalItens: type: integer format: int64 description: Total de itens para a paginação pagina: type: integer format: int64 description: Página atual itensPorPagina: type: integer format: int64 description: Quantidade de itens por página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaTotaisAtividades: post: description: Pesquisa totais de Atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filiais: type: array items: type: string description: Lista com o CNPJ de filiais listaStatus: type: array items: type: integer format: int64 description: Status de Aceite da atividade, onde não informado filtra todas, 0-Recusadas, 1-Em Análise, 2-Aceitas responses: 200: description: Ok schema: type: object required: – resultado – dsErro properties: resultado: type: object allOf: – #/definitions/TotaisAtividades description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa totais de Atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filiais description: Lista com o CNPJ de filiais in: query type: array items: type: string – name: listaStatus description: Status de Aceite da atividade, onde não informado filtra todas, 0-Recusadas, 1-Em Análise, 2-Aceitas in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object required: – resultado – dsErro properties: resultado: type: object allOf: – #/definitions/TotaisAtividades description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaAtividadesDiaVeiculo: post: description: Pesquisa de Atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: nrCNPJFilial: type: string description: Código identificador da filial nrPlaca: type: string description: Código identificador do dispostivo. Caso informado valor menor que zero, busca para todos os dispositivos. cdMotorista: type: integer format: int64 description: Código identificador do motorista responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista de Atividades 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: Código identificador da filial in: query type: string – name: nrPlaca description: Código identificador do dispostivo. Caso informado valor menor que zero, busca para todos os dispositivos. in: query type: string – name: cdMotorista description: Código identificador do motorista in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista de Atividades 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaAtividadesMonitoramento: post: description: Pesquisa de Atividades para o painel de monitoramento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: listaCnpjFilial: type: array items: type: string description: Código identificador da filial cdAtividade: type: integer format: int64 description: Código específico de uma atividade para resultado responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista de Atividades 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Atividades para o painel de monitoramento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: listaCnpjFilial description: Código identificador da filial in: query type: array items: type: string – name: cdAtividade description: Código específico de uma atividade para resultado in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista de Atividades 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaTotaisAtividadesSemRegiao: post: description: Pesquisa de Total de Atividades sem Região por Filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filiais properties: filiais: type: array items: type: string minimum: 1 description: Código identificador da filial responses: 200: description: Ok schema: type: object required: – listaResultado properties: temRegiao: type: boolean description: Tem Regiao Cadastrada default: true total: type: integer format: int64 description: Total Geral de Atividades default: 0 listaResultado: type: array items: type: object allOf: – #/definitions/totalizadorMCEATVSemRegiao minimum: 1 description: Lista dos Totais por Filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Total de Atividades sem Região por Filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filiais description: Código identificador da filial in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – listaResultado properties: temRegiao: type: boolean description: Tem Regiao Cadastrada default: true total: type: integer format: int64 description: Total Geral de Atividades default: 0 listaResultado: type: array items: type: object allOf: – #/definitions/totalizadorMCEATVSemRegiao minimum: 1 description: Lista dos Totais por Filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaAtividadesSemRegiao: post: description: Busca as Atividades sem Região tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filiais properties: filiais: type: array items: type: string minimum: 1 description: Código identificador da filial offset: type: integer format: int64 description: Página size: type: integer format: int64 description: Qtde por página responses: 200: description: Ok schema: type: object required: – atividades properties: atividades: type: array items: type: object allOf: – #/definitions/recAtividadeSemRegiao minimum: 1 description: Lista de Atividades totalItens: type: integer format: int64 description: Total de itens para a paginação pagina: type: integer format: int64 description: Página atual 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as Atividades sem Região tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filiais description: Código identificador da filial in: query required: true type: array items: type: string minimum: 1 – name: offset description: Página in: query type: integer format: int64 – name: size description: Qtde por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – atividades properties: atividades: type: array items: type: object allOf: – #/definitions/recAtividadeSemRegiao minimum: 1 description: Lista de Atividades totalItens: type: integer format: int64 description: Total de itens para a paginação pagina: type: integer format: int64 description: Página atual 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaAtividadesTorre: post: description: Pesquisa de Atividades para a Torre de Controle de forma assíncrona, devolvendo o resultado através do evento retornoAtividadesTorre tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtros properties: filtros: type: object allOf: – #/definitions/filtrosTorre description: Filtros da consulta responses: 200: description: Ok schema: type: object required: – mensagem – registrosPorPagina – totalRegistros – qtdPaginas – pagina properties: mensagem: type: string description: Mensagem de retorno para sinalizar que o processo é assincrono 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 /atividades/queries/buscaAtividadesApp: post: description: Busca Atividades para exibição no app tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdMotorista properties: cdMotorista: type: integer format: int64 description: Código identificador do motorista minimum: 1 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista de Atividades inOrdListaAtvPorLocal: type: integer format: int64 description: Ordenar listagem de atividades por localização inExigeApontamentoSeq: type: integer format: int64 description: Exige que o apontamento no aplicativo seja feita na ordem planejada. ATENÇÃO: essa funcionalidade é desabilitada caso a rota seja alterada após a execução 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca Atividades para exibição no app tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdMotorista description: Código identificador do motorista in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista de Atividades inOrdListaAtvPorLocal: type: integer format: int64 description: Ordenar listagem de atividades por localização inExigeApontamentoSeq: type: integer format: int64 description: Exige que o apontamento no aplicativo seja feita na ordem planejada. ATENÇÃO: essa funcionalidade é desabilitada caso a rota seja alterada após a execução 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaDadosRecebedor: post: description: Busca Dados Recebedor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRoteiro: type: integer format: int64 description: Código do roteiro cdAtividade: type: integer format: int64 description: Código da atividade responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: dsErro: type: string description: listaResultado: type: array items: type: object allOf: – #/definitions/dadosRecebedorRec minimum: 1 description: Lista Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca Dados Recebedor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteiro description: Código do roteiro in: query type: integer format: int64 – name: cdAtividade description: Código da atividade in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: dsErro: type: string description: listaResultado: type: array items: type: object allOf: – #/definitions/dadosRecebedorRec minimum: 1 description: Lista Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaRespostasQuestionario: post: description: Busca Respostas Questionario tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade properties: cdRoteiro: type: integer format: int64 description: Código do roteiro cdAtividade: type: integer format: int64 description: Código da atividade responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/recQuestionarioRespostasAtividade minimum: 1 description: Questionários e respostas do checklist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca Respostas Questionario tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteiro description: Código do roteiro in: query type: integer format: int64 – name: cdAtividade description: Código da atividade in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/recQuestionarioRespostasAtividade minimum: 1 description: Questionários e respostas do checklist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaTiposAtividades: post: description: Pesquisa de Tipo de Atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inAtividade properties: inAtividade: type: integer format: int64 description: Código identificador do tipo de atividade. Caso informado valor menor que zero, busca todas as atividades. responses: 200: description: Ok schema: type: object required: – tiposAtividades properties: tiposAtividades: type: array items: type: object allOf: – #/definitions/inAtividadeRec minimum: 1 description: Lista de tipos de atividades 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Tipo de Atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inAtividade description: Código identificador do tipo de atividade. Caso informado valor menor que zero, busca todas as atividades. in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – tiposAtividades properties: tiposAtividades: type: array items: type: object allOf: – #/definitions/inAtividadeRec minimum: 1 description: Lista de tipos de atividades 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaTiposDocumentos: post: description: Pesquisa de Tipo de documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inDocto properties: inDocto: type: integer format: int64 description: Código identificador do tipo de documento. Caso informado valor menor que zero, busca todos os tipos de documentos. responses: 200: description: Ok schema: type: object required: – listaInDocto properties: listaInDocto: type: array items: type: object allOf: – #/definitions/inDoctoRec minimum: 1 description: Lista de tipos de documentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Tipo de documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inDocto description: Código identificador do tipo de documento. Caso informado valor menor que zero, busca todos os tipos de documentos. in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaInDocto properties: listaInDocto: type: array items: type: object allOf: – #/definitions/inDoctoRec minimum: 1 description: Lista de tipos de documentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/carregaExcelAtividades: post: description: Pesquisa de Tipo de Atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – arquivo properties: arquivo: type: string format: byte description: Arquivo excel em formato binário ou base64. responses: 200: description: Ok schema: type: object required: – ok – erros – listaResultado properties: ok: type: boolean description: Boolean indicando se a operação teve êxito erros: type: array items: type: object allOf: – #/definitions/mensagemRec minimum: 1 description: Mensagens de erro, caso ocorram. listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista com as atividades carregadas temColunasDiferentes: type: boolean description: número total de colunas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Tipo de Atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: arquivo description: Arquivo excel em formato binário ou base64. in: query required: true type: string format: byte responses: 200: description: Ok schema: type: object required: – ok – erros – listaResultado properties: ok: type: boolean description: Boolean indicando se a operação teve êxito erros: type: array items: type: object allOf: – #/definitions/mensagemRec minimum: 1 description: Mensagens de erro, caso ocorram. listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista com as atividades carregadas temColunasDiferentes: type: boolean description: número total de colunas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaDirecoesExecutadas: post: description: Consulta de direções já geradas na roteirização tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteiro properties: cdRoteiro: type: integer format: int64 description: Código do roteiro que possui a direção cdAtividade: type: integer format: int64 description: Código do atividade que possui a direção responses: 200: description: Ok schema: type: object required: – ok – dsErro – tempo – distancia properties: ok: type: boolean description: Confirmação de sucesso dsErro: type: string description: Mensagem de Erro pontos: type: array items: type: object allOf: – #/definitions/recLatLon description: Pontos do tipo Latitude Longitude que compõem as direções tempo: type: integer format: int64 description: Tempo do trajeto distancia: type: number format: double description: Distância do trajeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de direções já geradas na roteirização tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteiro description: Código do roteiro que possui a direção in: query required: true type: integer format: int64 – name: cdAtividade description: Código do atividade que possui a direção in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – tempo – distancia properties: ok: type: boolean description: Confirmação de sucesso dsErro: type: string description: Mensagem de Erro pontos: type: array items: type: object allOf: – #/definitions/recLatLon description: Pontos do tipo Latitude Longitude que compõem as direções tempo: type: integer format: int64 description: Tempo do trajeto distancia: type: number format: double description: Distância do trajeto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaInfoNivelDeServicoAnalytics: post: description: Busca Atividades do Analytics tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dtInclusao – dtFinalizacao – arrFiliais – arrInSituacao – arrInStatus properties: dtInclusao: type: string format: date-time description: Data de criação da atividade dtFinalizacao: type: string format: date-time description: Data de finalização da atividades arrFiliais: type: array items: type: string minimum: 1 description: string com o cnpj das filiais (separados por vígula) dos usuário arrInSituacao: type: array items: type: integer format: int64 minimum: 1 description: array de inSituacao arrInStatus: type: array items: type: integer format: int64 minimum: 1 description: array de arrStatus filtrarPorDestino: type: boolean description: filtra atividades por destino filtrarPorGrupoDeVeiculos: type: boolean description: filtra atividades por grupo de veículos filtrarPorVeiculos: type: boolean description: filtra atividades por veículos filtrarPorMotorista: type: boolean description: filtra atividades por motorista responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaDeStatusContadorDoStatus properties: ok: type: boolean description: Confirmação de sucesso dsErro: type: string description: Mensagem de Erro listaDeStatusContadorDoStatus: type: array items: type: object allOf: – #/definitions/listaStatusEContadorStatusRec minimum: 1 description: Lista de status das atividades de acordo co o filtro (por destino, veículo, motorista, grupo de veículos) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca Atividades do Analytics tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dtInclusao description: Data de criação da atividade in: query required: true type: string format: date-time – name: dtFinalizacao description: Data de finalização da atividades in: query required: true type: string format: date-time – name: arrFiliais description: string com o cnpj das filiais (separados por vígula) dos usuário in: query required: true type: array items: type: string minimum: 1 – name: arrInSituacao description: array de inSituacao in: query required: true type: array items: type: integer format: int64 minimum: 1 – name: arrInStatus description: array de arrStatus in: query required: true type: array items: type: integer format: int64 minimum: 1 – name: filtrarPorDestino description: filtra atividades por destino in: query type: boolean – name: filtrarPorGrupoDeVeiculos description: filtra atividades por grupo de veículos in: query type: boolean – name: filtrarPorVeiculos description: filtra atividades por veículos in: query type: boolean – name: filtrarPorMotorista description: filtra atividades por motorista in: query type: boolean responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaDeStatusContadorDoStatus properties: ok: type: boolean description: Confirmação de sucesso dsErro: type: string description: Mensagem de Erro listaDeStatusContadorDoStatus: type: array items: type: object allOf: – #/definitions/listaStatusEContadorStatusRec minimum: 1 description: Lista de status das atividades de acordo co o filtro (por destino, veículo, motorista, grupo de veículos) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaDetalhesInfoNivelDeServicoAnalytics: post: description: Busca Informações das Grids do Panel Analytics (Nível de Serviço) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dtInclusao – dtFinalizacao – arrFiliais – arrInSituacao – arrInStatus properties: dtInclusao: type: string format: date-time description: Data de criação da atividade dtFinalizacao: type: string format: date-time description: Data de finalização da atividades arrFiliais: type: array items: type: string minimum: 1 description: string com o cnpj das filiais (separados por vígula) dos usuário arrInSituacao: type: array items: type: integer format: int64 minimum: 1 description: array de inSituacao arrInStatus: type: array items: type: integer format: int64 minimum: 1 description: array de arrStatus obterDadosAtvNoPrazoEmAtraso: type: boolean description: obtem dados das atividades (no prazo, em atraso) obterDadosAtvRealizadoNaoRealizado: type: boolean description: obtem dados das atividades (realizado, não realizado) filtrarPorDestino: type: boolean description: filtra atividades por destino filtrarPorGrupoDeVeiculos: type: boolean description: filtra atividades por grupo de veículos filtrarPorVeiculos: type: boolean description: filtra atividades por veículos filtrarPorMotorista: type: boolean description: filtra atividades por motorista offset: type: integer format: int64 description: Pagina corrente com resultados limit: type: integer format: int64 description: Quantidade de itens de resultado responses: 200: description: Ok schema: type: object required: – ok – dsErro – paginaAtual – itensPorPagina – totalItens – listaAtividadesNivelDeServico properties: ok: type: boolean description: Confirmação de sucesso dsErro: type: string description: Mensagem de Erro paginaAtual: type: integer format: int64 description: Pagina atual de resultados itensPorPagina: type: integer format: int64 description: Itens por retorno totalItens: type: integer format: int64 description: Quantidade total de itens da consulta listaAtividadesNivelDeServico: type: array items: type: object allOf: – #/definitions/listaAtividadesNivelDeServicoRec minimum: 1 description: Lista de informações da grid 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca Informações das Grids do Panel Analytics (Nível de Serviço) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dtInclusao description: Data de criação da atividade in: query required: true type: string format: date-time – name: dtFinalizacao description: Data de finalização da atividades in: query required: true type: string format: date-time – name: arrFiliais description: string com o cnpj das filiais (separados por vígula) dos usuário in: query required: true type: array items: type: string minimum: 1 – name: arrInSituacao description: array de inSituacao in: query required: true type: array items: type: integer format: int64 minimum: 1 – name: arrInStatus description: array de arrStatus in: query required: true type: array items: type: integer format: int64 minimum: 1 – name: obterDadosAtvNoPrazoEmAtraso description: obtem dados das atividades (no prazo, em atraso) in: query type: boolean – name: obterDadosAtvRealizadoNaoRealizado description: obtem dados das atividades (realizado, não realizado) in: query type: boolean – name: filtrarPorDestino description: filtra atividades por destino in: query type: boolean – name: filtrarPorGrupoDeVeiculos description: filtra atividades por grupo de veículos in: query type: boolean – name: filtrarPorVeiculos description: filtra atividades por veículos in: query type: boolean – name: filtrarPorMotorista description: filtra atividades por motorista in: query type: boolean – name: offset description: Pagina corrente com resultados in: query type: integer format: int64 – name: limit description: Quantidade de itens de resultado in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – paginaAtual – itensPorPagina – totalItens – listaAtividadesNivelDeServico properties: ok: type: boolean description: Confirmação de sucesso dsErro: type: string description: Mensagem de Erro paginaAtual: type: integer format: int64 description: Pagina atual de resultados itensPorPagina: type: integer format: int64 description: Itens por retorno totalItens: type: integer format: int64 description: Quantidade total de itens da consulta listaAtividadesNivelDeServico: type: array items: type: object allOf: – #/definitions/listaAtividadesNivelDeServicoRec minimum: 1 description: Lista de informações da grid 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaDetalhesRota: post: description: Pesquisa das informações da rota para apresentação dos detalhes, conforme roteirizadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: nrCNPJFilial: type: string description: Código identificador da filial cdRota: type: integer format: int64 description: Código identificador da rota cujo detalhes serão apresentados responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista de Atividades distanciaPlanejada: type: number format: double description: distanciaRealizada: type: number format: double description: tempoEmDeslocamentoPlanejado: type: number format: double description: tempoEmDeslocamentoRealizado: type: number format: double description: tempoParadoPlanejado: type: number format: double description: tempoParadoRealizado: type: number format: double description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa das informações da rota para apresentação dos detalhes, conforme roteirizadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: Código identificador da filial in: query type: string – name: cdRota description: Código identificador da rota cujo detalhes serão apresentados in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista de Atividades distanciaPlanejada: type: number format: double description: distanciaRealizada: type: number format: double description: tempoEmDeslocamentoPlanejado: type: number format: double description: tempoEmDeslocamentoRealizado: type: number format: double description: tempoParadoPlanejado: type: number format: double description: tempoParadoRealizado: type: number format: double description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaOperacoes: post: description: Pesquisa de Operações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdOperacao: type: integer format: int64 description: Código identificador da Operação cdReferencia: type: string description: Campo alfanumérico para referência do código no sistema legado dsOperacao: type: string description: Descrição da Operação nrCNPJFilial: type: string description: CNPJ da filial offset: type: integer format: int64 description: Página default: 0 limit: type: integer format: int64 description: Qtde por página default: 10 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEOPERec minimum: 1 description: Lista de Operações totalItens: type: integer format: int64 description: Total de itens para a paginação pagina: type: integer format: int64 description: Página atual itensPorPagina: type: integer format: int64 description: Quantidade de itens por página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Operações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdOperacao description: Código identificador da Operação in: query type: integer format: int64 – name: cdReferencia description: Campo alfanumérico para referência do código no sistema legado in: query type: string – name: dsOperacao description: Descrição da Operação in: query type: string – name: nrCNPJFilial description: CNPJ da filial in: query type: string – name: offset description: Página in: query type: integer format: int64 – name: limit description: Qtde por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEOPERec minimum: 1 description: Lista de Operações totalItens: type: integer format: int64 description: Total de itens para a paginação pagina: type: integer format: int64 description: Página atual itensPorPagina: type: integer format: int64 description: Quantidade de itens por página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaPerguntas: post: description: Busca de Perguntas – Checklist de entregas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: referencia: type: string description: Campo referência para controle deperguntas por parte do usuário descricao: type: string description: Descrição da pergunta ativo: type: boolean description: Ativo pageRequest: type: object allOf: – #/definitions/recPageRequest description: Page request responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos contents: type: array items: type: object allOf: – #/definitions/recPergunta minimum: 1 description: Lista de perguntas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaTiposCarga: post: description: Pesquisa de Tipos de Carga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdTipoCarga: type: integer format: int64 description: Código identificador do Tipo de Carga cdReferencia: type: string description: Campo alfanumérico para referência do código no sistema legado dsTipoCarga: type: string description: Descrição do Tipo de Carga carregaDepTpCargaIncomp: type: boolean description: Retornar vínculo com tipos de carga incompatível default: true nrCNPJFilial: type: string description: CNPJ da filial cdEspecie: type: integer format: int64 description: Código da espécie da carga inPrioridadeMaxima: type: boolean description: Prioridade máxima responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCETPCARRec minimum: 1 description: Lista de Tipos de Carga 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Tipos de Carga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdTipoCarga description: Código identificador do Tipo de Carga in: query type: integer format: int64 – name: cdReferencia description: Campo alfanumérico para referência do código no sistema legado in: query type: string – name: dsTipoCarga description: Descrição do Tipo de Carga in: query type: string – name: carregaDepTpCargaIncomp description: Retornar vínculo com tipos de carga incompatível in: query type: boolean – name: nrCNPJFilial description: CNPJ da filial in: query type: string – name: cdEspecie description: Código da espécie da carga in: query type: integer format: int64 – name: inPrioridadeMaxima description: Prioridade máxima in: query type: boolean responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCETPCARRec minimum: 1 description: Lista de Tipos de Carga 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/listaTipoCargaIncompativeis: post: description: Lista o tipo de cargas incompatíveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – numeroCnpjFilial properties: id: type: integer format: int64 description: Código tipo de carga numeroCnpjFilial: type: array items: type: string minimum: 1 description: Número CNPJ da filial responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCETPCARRec minimum: 1 description: Lista tipo de carga incompatíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista o tipo de cargas incompatíveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Código tipo de carga in: query required: true type: integer format: int64 – name: numeroCnpjFilial description: Número CNPJ da filial in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCETPCARRec minimum: 1 description: Lista tipo de carga incompatíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaEspeciesCarga: post: description: Pesquisa de Espécies de Carga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdEspCarga: type: integer format: int64 description: Código identificador da Espécie de Carga dsEspecie: type: string description: Descrição da Espécie de Carga dsAbreviacao: type: string description: Abreviação da espécie da carga queryDecoder: type: string description: Condições no padrão UrlQueryDecoder, conforme documentação da classe no projeto repository-specification-for-spring. Se informado, os demais atributos são ignorados na busca. responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEESPCARRec minimum: 1 description: Lista de Espécies de Carga 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Espécies de Carga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdEspCarga description: Código identificador da Espécie de Carga in: query type: integer format: int64 – name: dsEspecie description: Descrição da Espécie de Carga in: query type: string – name: dsAbreviacao description: Abreviação da espécie da carga in: query type: string – name: queryDecoder description: Condições no padrão UrlQueryDecoder, conforme documentação da classe no projeto repository-specification-for-spring. Se informado, os demais atributos são ignorados na busca. in: query type: string responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEESPCARRec minimum: 1 description: Lista de Espécies de Carga 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaGrauParentesco: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – content properties: content: type: object allOf: – #/definitions/GrauParentescoRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – content properties: content: type: object allOf: – #/definitions/GrauParentescoRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/obterUrlUploadFotoOcorrencia: post: description: Obtém Url para enviar a foto da ocorrencia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade – cdSeqOcorrencia properties: cdAtividade: type: integer format: int64 description: Código da Atividade cdSeqOcorrencia: type: integer format: int64 description: Código da Sequência da Ocorrência responses: 200: description: Ok schema: type: object required: – id – url – nome – versao – ok – imagemExists – dsErro properties: id: type: string description: id unico do arquivo no serviço url: type: string description: URL para upload do arquivo nome: type: string description: nome do arquivo versao: type: string description: versão do arquivo criado ok: type: boolean description: Sucesso na operação imagemExists: type: boolean description: Indica se a imagem já existe dsErro: type: string description: Mensagem caso erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém Url para enviar a foto da ocorrencia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdAtividade description: Código da Atividade in: query required: true type: integer format: int64 – name: cdSeqOcorrencia description: Código da Sequência da Ocorrência in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – id – url – nome – versao – ok – imagemExists – dsErro properties: id: type: string description: id unico do arquivo no serviço url: type: string description: URL para upload do arquivo nome: type: string description: nome do arquivo versao: type: string description: versão do arquivo criado ok: type: boolean description: Sucesso na operação imagemExists: type: boolean description: Indica se a imagem já existe dsErro: type: string description: Mensagem caso erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaFotoOcorrencia: post: description: Busca a foto ligada a ocorrência de uma atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade properties: cdRoteiro: type: integer format: int64 description: Código do roteiro cdAtividade: type: integer format: int64 description: Código da atividade cdSeqOcorrencia: type: integer format: int64 description: Código sequencial da ocorrência responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro resultado: type: object allOf: – #/definitions/MCEATVIMRec description: Lista Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca a foto ligada a ocorrência de uma atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteiro description: Código do roteiro in: query type: integer format: int64 – name: cdAtividade description: Código da atividade in: query required: true type: integer format: int64 – name: cdSeqOcorrencia description: Código sequencial da ocorrência in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro resultado: type: object allOf: – #/definitions/MCEATVIMRec description: Lista Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaAssinaturaOcorrencia: post: description: Busca assinatura ligada a ocorrência de uma atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade – cdSeqOcorrencia properties: cdAtividade: type: integer format: int64 description: Código da atividade cdSeqOcorrencia: type: integer format: int64 description: Código sequencial da ocorrência responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro resultado: type: object allOf: – #/definitions/MCEATVASRec description: Lista Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca assinatura ligada a ocorrência de uma atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdAtividade description: Código da atividade in: query required: true type: integer format: int64 – name: cdSeqOcorrencia description: Código sequencial da ocorrência in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro resultado: type: object allOf: – #/definitions/MCEATVASRec description: Lista Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaRestricoesRegiaoDetalhes: post: description: Busca as vinculações entre restrição e região com detalhes de ambas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRestricao: type: integer format: int64 description: Restrição a ser buscada cdRegiao: type: integer format: int64 description: Região a ser buscada responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/recRestricaoRegiaoDetalhes minimum: 1 description: Lista de resultado com detalhes das regiões e restrições 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as vinculações entre restrição e região com detalhes de ambas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRestricao description: Restrição a ser buscada in: query type: integer format: int64 – name: cdRegiao description: Região a ser buscada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/recRestricaoRegiaoDetalhes minimum: 1 description: Lista de resultado com detalhes das regiões e restrições 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaRestricoesTipoCargaDetalhes: post: description: Busca as vinculações entre restrição e tipo de carga com detalhes de ambas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRestricao: type: integer format: int64 description: Restrição a ser buscada cdTipoCarga: type: integer format: int64 description: Tipo de carga a ser buscada responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/recRestricaoTipoCargaDetalhes minimum: 1 description: Lista de resultado com detalhes das regiões e restrições 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as vinculações entre restrição e tipo de carga com detalhes de ambas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRestricao description: Restrição a ser buscada in: query type: integer format: int64 – name: cdTipoCarga description: Tipo de carga a ser buscada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/recRestricaoTipoCargaDetalhes minimum: 1 description: Lista de resultado com detalhes das regiões e restrições 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaRestricoesOperacao: post: description: Busca as vinculações entre restrição e operacao tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRestricao: type: integer format: int64 description: Restrição a ser buscada cdOperacao: type: integer format: int64 description: Operacao a ser buscada responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/recRestricaoOperacaoDetalhes minimum: 1 description: Lista de resultado com detalhes das operações e restrições 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as vinculações entre restrição e operacao tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRestricao description: Restrição a ser buscada in: query type: integer format: int64 – name: cdOperacao description: Operacao a ser buscada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/recRestricaoOperacaoDetalhes minimum: 1 description: Lista de resultado com detalhes das operações e restrições 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaTiposCargaAtividades: post: description: Busca Tipos de Carga das atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdAtividade: type: array items: type: integer format: int64 description: Lista de código de atividades responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista de resultado com os tipos de carga incompatíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca Tipos de Carga das atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdAtividade description: Lista de código de atividades in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista de resultado com os tipos de carga incompatíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaAtividadesRoteirizadas: post: description: Pesquisa atividades roteirizadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdDestino: type: string description: Código do Destino responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa atividades roteirizadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdDestino description: Código do Destino in: query type: string responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaFaixasHorarios: post: description: Consulta de faixas de horário das restrições tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRegiao: type: integer format: int64 description: Código da região cdRestricao: type: integer format: int64 description: Código da restrição diaSemana: type: integer format: int64 description: Dia da semana responses: 200: description: Ok schema: type: object required: – dsErro – ok – listaResultado properties: dsErro: type: string description: Caso tenha ocorrido algum erro, a mensagem será retornada ok: type: boolean description: False em caso de erro listaResultado: type: array items: type: object allOf: – #/definitions/recHorariosRestricao minimum: 1 description: Resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de faixas de horário das restrições tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRegiao description: Código da região in: query type: integer format: int64 – name: cdRestricao description: Código da restrição in: query type: integer format: int64 – name: diaSemana description: Dia da semana in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – dsErro – ok – listaResultado properties: dsErro: type: string description: Caso tenha ocorrido algum erro, a mensagem será retornada ok: type: boolean description: False em caso de erro listaResultado: type: array items: type: object allOf: – #/definitions/recHorariosRestricao minimum: 1 description: Resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaAlocacaoEProdutividade: post: description: Busca de alocação e produtividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dtRotaIni – dtRotaFim – arrFiliais properties: dtRotaIni: type: string format: date-time description: Data de criação da rota dtRotaFim: type: string format: date-time description: Data de finalização da rota arrFiliais: type: array items: type: string minimum: 1 description: string com o cnpj das filiais (separados por vígula) dos usuário filtrarPorGrupoDeVeiculos: type: boolean description: filtra atividades de rotas por grupo de veículos filtrarPorVeiculos: type: boolean description: filtra atividades de rotas por veículos filtrarPorMotorista: type: boolean description: filtra atividades de rotas por motorista responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: object allOf: – #/definitions/totaisAlocacaoProdutividadeRec description: Lista de totais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca de alocação e produtividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dtRotaIni description: Data de criação da rota in: query required: true type: string format: date-time – name: dtRotaFim description: Data de finalização da rota in: query required: true type: string format: date-time – name: arrFiliais description: string com o cnpj das filiais (separados por vígula) dos usuário in: query required: true type: array items: type: string minimum: 1 – name: filtrarPorGrupoDeVeiculos description: filtra atividades de rotas por grupo de veículos in: query type: boolean – name: filtrarPorVeiculos description: filtra atividades de rotas por veículos in: query type: boolean – name: filtrarPorMotorista description: filtra atividades de rotas por motorista in: query type: boolean responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: object allOf: – #/definitions/totaisAlocacaoProdutividadeRec description: Lista de totais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaRestricoesDiasUteisDestino: post: description: Busca Dias úteis do Destino pela atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade – dtInicio – qtDiasRoteirizacao – cdRoteirizacao properties: cdAtividade: type: integer format: int64 description: Código identificador da Atividade dtInicio: type: string format: date-time description: data de início dos roteiros na roteirizacao qtDiasRoteirizacao: type: integer format: int64 description: Quantidade de dias da roteirização. Deve ser um número maior que 0 (zero) cdRoteirizacao: type: integer format: int64 description: Código identificado da roteirização arNrPlaca: type: array items: type: string description: lista de placas arCdGrupoVeiculo: type: array items: type: integer format: int64 description: lista de grupos (Agrupamento Dinâmico) responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: object allOf: – #/definitions/recRestricoesDiasUteisDestino description: Lista de Operações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca Dias úteis do Destino pela atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdAtividade description: Código identificador da Atividade in: query required: true type: integer format: int64 – name: dtInicio description: data de início dos roteiros na roteirizacao in: query required: true type: string format: date-time – name: qtDiasRoteirizacao description: Quantidade de dias da roteirização. Deve ser um número maior que 0 (zero) in: query required: true type: integer format: int64 – name: cdRoteirizacao description: Código identificado da roteirização in: query required: true type: integer format: int64 – name: arNrPlaca description: lista de placas in: query type: array items: type: string – name: arCdGrupoVeiculo description: lista de grupos (Agrupamento Dinâmico) in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: object allOf: – #/definitions/recRestricoesDiasUteisDestino description: Lista de Operações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaOcorrencias: post: description: Consulta dados principais das ocorrências. Não retorna os dados de foto/assinatura. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRoteiro: type: integer format: int64 description: Código do roteiro. Obrigatório caso campo cdAtividade não informado. cdAtividade: type: integer format: int64 description: Código da atividade. Obrigatório caso campo cdRoteiro não informado. cdSequencia: type: integer format: int64 description: Sequência da movimentação cdOcorrencia: type: integer format: int64 description: Código da ocorrência lançada responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Identificador de sucesso dsErro: type: string description: Mensagem de erro da operacao, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVMVRec minimum: 1 description: Ocorrências não sincronizadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta dados principais das ocorrências. Não retorna os dados de foto/assinatura. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteiro description: Código do roteiro. Obrigatório caso campo cdAtividade não informado. in: query type: integer format: int64 – name: cdAtividade description: Código da atividade. Obrigatório caso campo cdRoteiro não informado. in: query type: integer format: int64 – name: cdSequencia description: Sequência da movimentação in: query type: integer format: int64 – name: cdOcorrencia description: Código da ocorrência lançada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Identificador de sucesso dsErro: type: string description: Mensagem de erro da operacao, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVMVRec minimum: 1 description: Ocorrências não sincronizadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaOcorrenciasNaoSincronizadas: post: description: Atenção: ao utilizar essa busca, os registros retornados não aparecerão em consultas futuras. Específico para clientes que utilizam as APIs para integrar ocorrências realizadas para dentro de seus sistemas. Limite de 100 registros por vêz tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRoteiro: type: integer format: int64 description: Código do roteiro cdAtividade: type: integer format: int64 description: Código da atividade cdSequencia: type: integer format: int64 description: Sequência da movimentação responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Identificador de sucesso dsErro: type: string description: Mensagem de erro da operacao, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVMVRec minimum: 1 description: Ocorrências não sincronizadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Atenção: ao utilizar essa busca, os registros retornados não aparecerão em consultas futuras. Específico para clientes que utilizam as APIs para integrar ocorrências realizadas para dentro de seus sistemas. Limite de 100 registros por vêz tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteiro description: Código do roteiro in: query type: integer format: int64 – name: cdAtividade description: Código da atividade in: query type: integer format: int64 – name: cdSequencia description: Sequência da movimentação in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Identificador de sucesso dsErro: type: string description: Mensagem de erro da operacao, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVMVRec minimum: 1 description: Ocorrências não sincronizadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaFotosOcorrenciasNaoSincronizadas: post: description: Atenção: ao utilizar essa busca, os registros retornados não aparecerão em consultas futuras. Específico para clientes que utilizam as APIs para integrar fotos de ocorrências para dentro de seus sistemas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdAtividade: type: integer format: int64 description: Código da atividade cdSequencia: type: integer format: int64 description: Sequência da movimentação responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Identificador de sucesso dsErro: type: string description: Mensagem de erro da operacao, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVIMRec minimum: 1 description: Fotos não sincronizadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Atenção: ao utilizar essa busca, os registros retornados não aparecerão em consultas futuras. Específico para clientes que utilizam as APIs para integrar fotos de ocorrências para dentro de seus sistemas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdAtividade description: Código da atividade in: query type: integer format: int64 – name: cdSequencia description: Sequência da movimentação in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Identificador de sucesso dsErro: type: string description: Mensagem de erro da operacao, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVIMRec minimum: 1 description: Fotos não sincronizadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaAssinaturasOcorrenciasNaoSincronizadas: post: description: Atenção: ao utilizar essa busca, os registros retornados não aparecerão em consultas futuras. Específico para clientes que utilizam as APIs para integrar assinaturas de ocorrências para dentro de seus sistemas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdAtividade: type: integer format: int64 description: Código da atividade cdSequencia: type: integer format: int64 description: Sequência da movimentação responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Identificador de sucesso dsErro: type: string description: Mensagem de erro da operacao, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVASRec minimum: 1 description: Assinaturas não sincronizadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Atenção: ao utilizar essa busca, os registros retornados não aparecerão em consultas futuras. Específico para clientes que utilizam as APIs para integrar assinaturas de ocorrências para dentro de seus sistemas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdAtividade description: Código da atividade in: query type: integer format: int64 – name: cdSequencia description: Sequência da movimentação in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Identificador de sucesso dsErro: type: string description: Mensagem de erro da operacao, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVASRec minimum: 1 description: Assinaturas não sincronizadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaRestricoesRegiaoOperacaoTipoCarga: post: description: Busca restrições aplicadas por regiões, operações e tipos de carga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade properties: cdAtividade: type: integer format: int64 description: Código identificador da Atividade arNrPlaca: type: array items: type: string description: lista de placas arCdGrupoVeiculo: type: array items: type: integer format: int64 description: lista de grupos (Agrupamento Dinâmico) cdRoteirizacao: type: integer format: int64 description: código identificador da roteirização responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: object allOf: – #/definitions/recRestricoesRegiaoOperacaoTipoCarga description: Lista de Operações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca restrições aplicadas por regiões, operações e tipos de carga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdAtividade description: Código identificador da Atividade in: query required: true type: integer format: int64 – name: arNrPlaca description: lista de placas in: query type: array items: type: string – name: arCdGrupoVeiculo description: lista de grupos (Agrupamento Dinâmico) in: query type: array items: type: integer format: int64 – name: cdRoteirizacao description: código identificador da roteirização in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: object allOf: – #/definitions/recRestricoesRegiaoOperacaoTipoCarga description: Lista de Operações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaAtividadesMovimentadas: post: description: Busca atividades com movimentações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdAtividade: type: integer format: int64 description: Código da atividade cdOcorrencia: type: integer format: int64 description: Código da ocorrência responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVMVRec minimum: 1 description: Lista de Operações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca atividades com movimentações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdAtividade description: Código da atividade in: query type: integer format: int64 – name: cdOcorrencia description: Código da ocorrência in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVMVRec minimum: 1 description: Lista de Operações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaUltimaRotaDaAtividade: post: description: Busca a última rota da atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade properties: cdAtividade: type: integer format: int64 description: Código da atividade responses: 200: description: Ok schema: type: object required: – ok – dsErro – cdRoteiro properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro cdRoteiro: type: integer format: int64 description: Código da última rota da atividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca a última rota da atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdAtividade description: Código da atividade in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – cdRoteiro properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro cdRoteiro: type: integer format: int64 description: Código da última rota da atividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaTempoAtendimentoExecutado: post: description: Busca o tempo executado da atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tmpExecRota – tmpExecAtv properties: tmpExecRota: type: boolean description: consultar o tempo executado da rota tmpExecAtv: type: boolean description: consultar o tempo executado da atividade cdAtividade: type: integer format: int64 description: Código da Atividade cdRoteiro: type: integer format: int64 description: Código da Rota responses: 200: description: Ok schema: type: object required: – ok – dsErro – qtTempoAtendExecutadoRota – qtTempoAtendExecutadoAtv properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro qtTempoAtendExecutadoRota: type: integer format: int64 description: Quantidade de tempo de atendimento da Rota qtTempoAtendExecutadoAtv: type: integer format: int64 description: Quantidade de tempo de atendimento da Atividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o tempo executado da atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tmpExecRota description: consultar o tempo executado da rota in: query required: true type: boolean – name: tmpExecAtv description: consultar o tempo executado da atividade in: query required: true type: boolean – name: cdAtividade description: Código da Atividade in: query type: integer format: int64 – name: cdRoteiro description: Código da Rota in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – qtTempoAtendExecutadoRota – qtTempoAtendExecutadoAtv properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro qtTempoAtendExecutadoRota: type: integer format: int64 description: Quantidade de tempo de atendimento da Rota qtTempoAtendExecutadoAtv: type: integer format: int64 description: Quantidade de tempo de atendimento da Atividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaEmbarcadores: post: description: Busca lista de embarcadores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: listaCdEmbarcador: type: array items: type: string description: lista de códigos dos embarcadores dsEmbarcador: type: string description: descrição do embarcador nrCPFCNPJEmbarcador: type: string description: cpf ou cnpf do embarcador filiais: type: array items: type: string description: filiais do embarcadores ocorrencias: type: array items: type: integer format: int64 description: Códigos dos Tipos de Ocorrência offset: type: integer format: int64 description: Página limit: type: integer format: int64 description: Qtde por página responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEEMBrec minimum: 1 description: lista de embarcadores totalItens: type: integer format: int64 description: total de embarcadores na tabela 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca lista de embarcadores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: listaCdEmbarcador description: lista de códigos dos embarcadores in: query type: array items: type: string – name: dsEmbarcador description: descrição do embarcador in: query type: string – name: nrCPFCNPJEmbarcador description: cpf ou cnpf do embarcador in: query type: string – name: filiais description: filiais do embarcadores in: query type: array items: type: string – name: ocorrencias description: Códigos dos Tipos de Ocorrência in: query type: array items: type: integer format: int64 – name: offset description: Página in: query type: integer format: int64 – name: limit description: Qtde por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/MCEEMBrec minimum: 1 description: lista de embarcadores totalItens: type: integer format: int64 description: total de embarcadores na tabela 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaConfiguracoes: post: description: Busca as configurações do sistema tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: dsUrlServidor: type: string description: Url do servidor offset: type: integer format: int64 description: Paginação – Desconsidera uma quantidade de linhas no inicio limit: type: integer format: int64 description: Paginação – Total de linhas responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/configuracaoRec minimum: 1 description: Lista de configurações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as configurações do sistema tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dsUrlServidor description: Url do servidor in: query type: string – name: offset description: Paginação – Desconsidera uma quantidade de linhas no inicio in: query type: integer format: int64 – name: limit description: Paginação – Total de linhas in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/configuracaoRec minimum: 1 description: Lista de configurações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaImportacoes: post: description: Busca importações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: listaCdImportacao: type: array items: type: integer format: int64 description: Lista de códigos de importações dsImportacao: type: string description: Descrição da importação inImportacao: type: integer format: int64 description: Tipo da importação: 1: InsereLoteAtividades API; 2: InsereLoteAtividades EXCEL dsEntrada: type: string description: Entrada da importacao dtInicio: type: string format: date-time description: Data inicial da importacao dtFim: type: string format: date-time description: Data final da importacao dsUsuario: type: string description: Usuário que executou a importação offset: type: integer format: int64 description: Paginação – Desconsidera uma quantidade de linhas no inicio limit: type: integer format: int64 description: Paginação – Total de linhas responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/importacaoRec minimum: 1 description: Lista de importações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca importações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: listaCdImportacao description: Lista de códigos de importações in: query type: array items: type: integer format: int64 – name: dsImportacao description: Descrição da importação in: query type: string – name: inImportacao description: Tipo da importação: 1: InsereLoteAtividades API; 2: InsereLoteAtividades EXCEL in: query type: integer format: int64 – name: dsEntrada description: Entrada da importacao in: query type: string – name: dtInicio description: Data inicial da importacao in: query type: string format: date-time – name: dtFim description: Data final da importacao in: query type: string format: date-time – name: dsUsuario description: Usuário que executou a importação in: query type: string – name: offset description: Paginação – Desconsidera uma quantidade de linhas no inicio in: query type: integer format: int64 – name: limit description: Paginação – Total de linhas in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/importacaoRec minimum: 1 description: Lista de importações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaImportacoesComLogs: post: description: Busca importações com logs tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: listaCdImportacao: type: array items: type: integer format: int64 description: Lista de códigos de importações dsImportacao: type: string description: Descrição da importação inImportacao: type: integer format: int64 description: Tipo da importação dsEntrada: type: string description: Entrada da importacao dtInicio: type: string format: date-time description: Data inicial da importacao dtFim: type: string format: date-time description: Data final da importacao dsUsuario: type: string description: Usuário que executou a importação listaCdLog: type: array items: type: integer format: int64 description: Lista de códigos de logs dsErro: type: string description: Descrição do erro ocorrido dsItens: type: string description: Itens que causaram o erro dtLog: type: string format: date-time description: Data do log offset: type: integer format: int64 description: Paginação – Desconsidera uma quantidade de linhas no inicio limit: type: integer format: int64 description: Paginação – Total de linhas responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/importacaoComLogRec minimum: 1 description: Lista de importações com logs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca importações com logs tags: – Queries x-senior-visibility: PRIVATE parameters: – name: listaCdImportacao description: Lista de códigos de importações in: query type: array items: type: integer format: int64 – name: dsImportacao description: Descrição da importação in: query type: string – name: inImportacao description: Tipo da importação in: query type: integer format: int64 – name: dsEntrada description: Entrada da importacao in: query type: string – name: dtInicio description: Data inicial da importacao in: query type: string format: date-time – name: dtFim description: Data final da importacao in: query type: string format: date-time – name: dsUsuario description: Usuário que executou a importação in: query type: string – name: listaCdLog description: Lista de códigos de logs in: query type: array items: type: integer format: int64 – name: dsErro description: Descrição do erro ocorrido in: query type: string – name: dsItens description: Itens que causaram o erro in: query type: string – name: dtLog description: Data do log in: query type: string format: date-time – name: offset description: Paginação – Desconsidera uma quantidade de linhas no inicio in: query type: integer format: int64 – name: limit description: Paginação – Total de linhas in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/importacaoComLogRec minimum: 1 description: Lista de importações com logs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaImportacoesLogs: post: description: Busca logs de importações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: listaCdLog: type: array items: type: integer format: int64 description: Lista de códigos de logs listaCdImportacao: type: array items: type: integer format: int64 description: Lista de códigos de importações dsErro: type: string description: Descrição do erro ocorrido dsItens: type: string description: Itens que causaram o erro dtLog: type: string format: date-time description: Data do log offset: type: integer format: int64 description: Paginação – Desconsidera uma quantidade de linhas no inicio limit: type: integer format: int64 description: Paginação – Total de linhas responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/importacaoLogRec minimum: 1 description: Lista de importações com logs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca logs de importações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: listaCdLog description: Lista de códigos de logs in: query type: array items: type: integer format: int64 – name: listaCdImportacao description: Lista de códigos de importações in: query type: array items: type: integer format: int64 – name: dsErro description: Descrição do erro ocorrido in: query type: string – name: dsItens description: Itens que causaram o erro in: query type: string – name: dtLog description: Data do log in: query type: string format: date-time – name: offset description: Paginação – Desconsidera uma quantidade de linhas no inicio in: query type: integer format: int64 – name: limit description: Paginação – Total de linhas in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/importacaoLogRec minimum: 1 description: Lista de importações com logs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaComposicoes: post: description: Pesquisa de Composições tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdComposicao: type: integer format: int64 description: Código identificador da Composição nrCNPJFilial: type: string description: Código identificador da filial dsNrComposicao: type: string description: Número da composição inPrioridade: type: integer format: int64 description: Prioridade: campo numérico cdTipoCarga: type: integer format: int64 description: Tipo de Carga cdEspCarga: type: integer format: int64 description: Espécie de Carga cdOperacao: type: integer format: int64 description: Operação dsObservacao: type: string description: Observação cdEmbarcador: type: string description: Código do embarcador offset: type: integer format: int64 description: Página limit: type: integer format: int64 description: Qtde por página ordenacao: type: string allOf: – #/definitions/ordenacao description: Ordem Ex.: ASC, DESC responses: 200: description: Ok schema: type: object required: – composicoes properties: composicoes: type: array items: type: object allOf: – #/definitions/PVICOMPRec minimum: 1 description: Lista de Composições totalItens: type: integer format: int64 description: Total de itens para a paginação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaComposicoesDisponiveis: post: description: Pesquisa de Composições Disponíveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdComposicao: type: integer format: int64 description: Código identificador da Composição nrCNPJFilial: type: string description: Código identificador da filial dsNrComposicao: type: string description: Número da composição inPrioridade: type: integer format: int64 description: Prioridade: campo numérico cdTipoCarga: type: integer format: int64 description: Tipo de Carga cdEspCarga: type: integer format: int64 description: Espécie de Carga cdOperacao: type: integer format: int64 description: Operação dsObservacao: type: string description: Observação cdEmbarcador: type: string description: Código do embarcador offset: type: integer format: int64 description: Página limit: type: integer format: int64 description: Qtde por página ordenacao: type: string allOf: – #/definitions/ordenacao description: Ordem Ex.: ASC, DESC responses: 200: description: Ok schema: type: object required: – composicoes properties: composicoes: type: array items: type: object allOf: – #/definitions/PVICOMPRec minimum: 1 description: Lista de Composições totalItens: type: integer format: int64 description: Total de itens para a paginação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaInicializacoes: post: description: Busca as inicializações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: dsErro: type: string description: listaResultado: type: array items: type: object allOf: – #/definitions/inicializacaoRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as inicializações tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: dsErro: type: string description: listaResultado: type: array items: type: object allOf: – #/definitions/inicializacaoRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/obterAcessoDownloadFotoOcorrencia: post: description: Obtém os dados necessários para realizar o Download de um arquivo ao informar seu o Id do aqruivo salvo no serviço de arquivos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idBlobServiceFile properties: idBlobServiceFile: type: string description: Id do arquivo salvo no serviço de arquivos responses: 200: description: Ok schema: type: object required: – dadosArquivoSoliciatado properties: dadosArquivoSoliciatado: type: object allOf: – #/definitions/dadosAcessoArquivo description: Dados de acesso para realizar download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os dados necessários para realizar o Download de um arquivo ao informar seu o Id do aqruivo salvo no serviço de arquivos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idBlobServiceFile description: Id do arquivo salvo no serviço de arquivos in: query required: true type: string responses: 200: description: Ok schema: type: object required: – dadosArquivoSoliciatado properties: dadosArquivoSoliciatado: type: object allOf: – #/definitions/dadosAcessoArquivo description: Dados de acesso para realizar download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/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 /atividades/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 /atividades/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 /atividades/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 /atividades/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 /atividades/queries/buscaRegrasQuestionarios: post: description: Busca regras questionário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigo: type: integer format: int64 description: Código identificador da Regra descricao: type: string description: Descrição do questionário ocorrencia: type: integer format: int64 description: Ocorrencia tipoCarga: type: integer format: int64 description: Tipo de carga especieCarga: type: integer format: int64 description: Espécie de carga questionario: type: integer format: int64 description: Questionario ativo: type: boolean description: Ativo pageRequest: type: object allOf: – #/definitions/recPageRequest description: Page request responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de registros contents: type: array items: type: object allOf: – #/definitions/recRegraQuestionario minimum: 1 description: Lista de Questionários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaQuestionarios: post: description: Busca questionários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigo: type: integer format: int64 description: Código identificador do questionário descricao: type: string description: Descrição do questionário ativo: type: boolean description: Ativo pageRequest: type: object allOf: – #/definitions/recPageRequest description: Page request responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de registros contents: type: array items: type: object allOf: – #/definitions/recQuestionario minimum: 1 description: Lista de Questionários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaPerguntasQuestionario: post: description: Busca perguntas vinculadas a determinado questionário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigoQuestionario: type: integer format: int64 description: Código identificador do questionário offset: type: integer format: int64 description: Página. Para retornar do primeiro registro ao quinto, informa-se offset=0 size=5. Para obter do sexto registro ao décimo, informa-se offset=1&size=5 default: 0 size: type: integer format: int64 description: Qtdepor página default: 10 responses: 200: description: Ok schema: type: object required: – contents – atividadeVinculada properties: contents: type: array items: type: object allOf: – #/definitions/recPergunta minimum: 1 description: Perguntas vinculadas ao questionário atividadeVinculada: type: boolean description: Retorna se tem atiidade vinculada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca perguntas vinculadas a determinado questionário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoQuestionario description: Código identificador do questionário in: query type: integer format: int64 – name: offset description: Página. Para retornar do primeiro registro ao quinto, informa-se offset=0 size=5. Para obter do sexto registro ao décimo, informa-se offset=1&size=5 in: query type: integer format: int64 – name: size description: Qtdepor página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contents – atividadeVinculada properties: contents: type: array items: type: object allOf: – #/definitions/recPergunta minimum: 1 description: Perguntas vinculadas ao questionário atividadeVinculada: type: boolean description: Retorna se tem atiidade vinculada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/buscaQuestionariosAtividades: post: description: Busca questionários das atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdAtividade: type: array items: type: integer format: int64 description: Lista de códigos de atividade. Obrigatório caso não informado campodsNrDocto dsNrDocto: type: array items: type: string description: Lista de números de documento deatividade. Obrigatório caso não informado campo cdAtividade responses: 200: description: Ok schema: type: object required: – questionarioAtividade – questionarios properties: questionarioAtividade: type: array items: type: object allOf: – #/definitions/recQuestionarioAtividade minimum: 1 description: Retorna apenas atividades com questionário a serapresentado questionarios: type: array items: type: object allOf: – #/definitions/recQuestionarioCompleto minimum: 1 description: Retornaapenas questionários encontrados no campo questionarioAtividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca questionários das atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdAtividade description: Lista de códigos de atividade. Obrigatório caso não informado campodsNrDocto in: query type: array items: type: integer format: int64 – name: dsNrDocto description: Lista de números de documento deatividade. Obrigatório caso não informado campo cdAtividade in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – questionarioAtividade – questionarios properties: questionarioAtividade: type: array items: type: object allOf: – #/definitions/recQuestionarioAtividade minimum: 1 description: Retorna apenas atividades com questionário a serapresentado questionarios: type: array items: type: object allOf: – #/definitions/recQuestionarioCompleto minimum: 1 description: Retornaapenas questionários encontrados no campo questionarioAtividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/queries/listaGrauParentesco: post: description: Primitiva para listar os graus de parentesco tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: integer format: int64 description: Id do grau de parentesco descricao: type: string description: Descrição do grau de parentesco ativo: type: boolean description: Status do grau de parentesco offset: type: integer format: int64 description: Página atual da consulta default: 0 size: type: integer format: int64 description: Quantidade de registro por página default: 10 responses: 200: description: Ok schema: type: object required: – content – totalPage – totalElements properties: content: type: array items: type: object allOf: – #/definitions/GrauParentescoRec minimum: 1 description: Retorna a listagem dos graus de parentesco totalPage: type: integer format: int64 description: Retorna a quantidade páginas totalElements: type: integer format: int64 description: Retorna a quantidade de elementos por página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para listar os graus de parentesco tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Id do grau de parentesco in: query type: integer format: int64 – name: descricao description: Descrição do grau de parentesco in: query type: string – name: ativo description: Status do grau de parentesco in: query type: boolean – name: offset description: Página atual da consulta in: query type: integer format: int64 – name: size description: Quantidade de registro por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – content – totalPage – totalElements properties: content: type: array items: type: object allOf: – #/definitions/GrauParentescoRec minimum: 1 description: Retorna a listagem dos graus de parentesco totalPage: type: integer format: int64 description: Retorna a quantidade páginas totalElements: type: integer format: int64 description: Retorna a quantidade de elementos por página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/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 /atividades/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 /atividades/actions/insereAtividade: post: description: Cadastro de Atividade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inAtividade – dsDestinatario – dsNrDocto properties: nrCNPJFilial: type: string description: Código identificador da filial inAtividade: type: integer format: int64 description: Tipo da Atividade. Ex: Coleta, Entrega. cdDestino: type: string description: Código do Destino (serviço empresas) dsDestinatario: type: string description: Destinatário da atividade dsLocal: type: string description: Local (endereço) onde a atividade será realizada cdNumero: type: integer format: int64 description: Número do (endereço) onde a atividade será realizada dsComplemento: type: string description: Descrição (endereço) onde a atividade será realizada dsBairro: type: string description: Bairro (endereço) onde a atividade será realizada dsCidade: type: string description: Município (endereço) onde a atividade será realizada dsEstado: type: string description: Estado (endereço) onde a atividade será realizada dsPais: type: string description: País (endereço) onde a atividade será realizada qtVolumes: type: number format: double description: Quantidade de volumes referentes a atividade. Ex: Coleta de 2 volumes. qtPeso: type: number format: double description: Peso total dos volumes da atividade. Ex: 5.000,00 kg hrLimite: type: string format: date-time description: Horário limite para coletas dsNrDocto: type: string description: Número do documento (romaneio, nf, etc.) dtPrazoEntr: type: string format: date-time description: Data do Prazo de Entrega. opcional para a modalidade de transporte lotação inModTransp: type: integer format: int64 description: tipo de modalidade de transporte dsLat: type: string description: Latitude geográfica dsLong: type: string description: Longitudade geográfica nrCep: type: integer format: int64 description: CEP do local da atividade dtJanelaIni: type: string format: date-time description: Janela de data e hora início dtJanelaFim: type: string format: date-time description: Janela de data e hora Fim qtTempoAtend: type: string format: date-time description: Tempo de atendimento em horas/minutos(hh:mm) qtMetrosCubicos: type: number format: double description: Quantidade em metros cúbicos inPrioridade: type: integer format: int64 description: Prioridade: campo numérico nrTelefoneContato: type: string description: Telefone de contato do cliente: campo opcional cdTipoCarga: type: integer format: int64 description: Tipo de Carga cdEspCarga: type: integer format: int64 description: Código identificador da Espécie de Carga cdOperacao: type: integer format: int64 description: Operação dsObservacao: type: string description: Observação dtAgendamento: type: string format: date-time description: Data utilizada para apresentar ou não atividade durante seleção na roteirização cdEmbarcador: type: string description: Código do embarcador inDocto: type: integer format: int64 description: Tipo de documento cdComposicao: type: integer format: int64 description: Código da composição cdChaveAcesso: type: string description: Chave eletrônica de acesso referente ao documento fiscal representado idPontoApoio: type: integer format: int64 description: Código Ponto de apoio da filial (caso a filial tenha) vlMercadoria: type: number format: double description: Valor da Mercadoria default: 0.0 responses: 200: description: Ok schema: type: object required: – ok – dsErro – atividade properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Descrição do Erro caso não ok atividade: type: object allOf: – #/definitions/MCEATVRec description: atividade inserida 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereRegiao: post: description: Cadastro de Regiões tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filiais properties: cdRegiao: type: integer format: int64 description: Código identificador da Região dsDescricao: type: string description: Descrição da Região cdReferencia: type: string description: Campo alfanumérico para refência do código no sistema legado inStatus: type: integer format: int64 description: Status da Região. Ex: Ativo/Inativo inTipo: type: integer format: int64 description: Tipo da região cadastrada. Ex: Por Endereço/ Por Mapa poligonos: type: array items: type: object allOf: – #/definitions/PoligonoRec description: Polígonos da região filiais: type: array items: type: string minimum: 1 description: Lista com o CNPJ de filiais responses: 200: description: Ok schema: type: object required: – ok – cdRegiao – dsErro properties: ok: type: boolean description: Confirmação de retorno com sucesso cdRegiao: type: integer format: int64 description: código da região gerada dsErro: type: string description: Descrição do erro caso não ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraRegiao: post: description: Alteração de Regiões tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRegiao – filiais properties: cdRegiao: type: integer format: int64 description: Código identificador da Região dsDescricao: type: string description: Descrição da Região cdReferencia: type: string description: Campo alfanumérico para refência do código no sistema legado inStatus: type: integer format: int64 description: Status da Região. Ex: Ativo/Inativo inTipo: type: integer format: int64 description: Tipo da região cadastrada. Ex: Por Endereço/ Por Mapa poligonos: type: array items: type: object allOf: – #/definitions/PoligonoRec description: Polígonos da região filiais: type: array items: type: string minimum: 1 description: Lista com o CNPJ de filiais usuario: type: string description: Usuario para receber notificacao responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Confirmação de retorno com sucesso dsErro: type: string description: Descrição do erro caso não ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaRegiao: post: description: Exclusao de Região tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRegiao properties: cdRegiao: type: integer format: int64 description: Código identificador da região responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Mensagem de Erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereEndRegiao: post: description: Cadastro de Endereços da Região tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRegiao – inTipoEnd properties: cdRegiao: type: integer format: int64 description: Código identificador da Região inTipoEnd: type: integer format: int64 description: Tipo do endereço da região cadastrada. Ex: Por CEP/ Por Logradouro nrFxCEPIni: type: integer format: int64 description: Faixa de CEP inicial nrFxCEPFin: type: integer format: int64 description: Faixa de CEP final dsLogradouro: type: string description: Logradouro/Endereço nrFxNumIni: type: integer format: int64 description: Faixa de Número inicial nrFxNumFin: type: integer format: int64 description: Faixa de Número final dsBairro: type: string description: Bairro dsCidade: type: string description: Cidade dsEstado: type: string description: Estado dsPais: type: string description: País responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Confirmação de retorno com sucesso dsErro: type: string description: Descrição do erro caso não ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraEndRegiao: post: description: Alteração de Endereços da Região tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRegiao – cdSequencia – inTipoEnd properties: cdRegiao: type: integer format: int64 description: Código identificador da Região cdSequencia: type: integer format: int64 description: Sequência do Endereço inTipoEnd: type: integer format: int64 description: Tipo do endereço da região cadastrada. Ex: Por CEP/ Por Logradouro nrFxCEPIni: type: integer format: int64 description: Faixa de CEP inicial nrFxCEPFin: type: integer format: int64 description: Faixa de CEP final dsLogradouro: type: string description: Logradouro/Endereço nrFxNumIni: type: integer format: int64 description: Faixa de Número inicial nrFxNumFin: type: integer format: int64 description: Faixa de Número final dsBairro: type: string description: Bairro dsCidade: type: string description: Cidade dsEstado: type: string description: Estado dsPais: type: string description: País responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Confirmação de retorno com sucesso dsErro: type: string description: Descrição do erro caso não ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaEndRegiao: post: description: Exclusao de Endereço da Região tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRegiao – cdSequencia properties: cdRegiao: type: integer format: int64 description: Código identificador da região cdSequencia: type: integer format: int64 description: Sequencia do Endereço responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Mensagem de Erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereLoteAtividades: post: description: Cadastro de Atividades em Lote: Recomendado para integrações. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – atividades properties: atividades: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Atividades a serem gravas. Caso possuam o campo RefRota preenchido, será gerado um roteiro para a atividade. usuario: type: string description: E-mail do usuário que será notificado na plataforma Senior X assim que o processo de geocodificação das atividades que foram inseridas for concluído. inOutputErro: type: integer format: int64 description: 1- Todos os erros em dsErro e em erros. 2- Todos os erros em dsErro, 3- Todos os erros em erros. Padrão: 1 inSitRotNovo: type: integer format: int64 description: Situação em que os novos roteiros estarão. Padrão: 1 (confirmado) importacao: type: object allOf: – #/definitions/importacaoRec description: qtDiasRoteirizacao: type: integer format: int64 description: qtTempoAtendPad: type: string format: date-time description: primitiva: type: string description: Primitiva atualizaFilialVeiculoExistente: type: boolean description: Indica que a filial do veículo já cadastrado será atualizada conforme a filial informada na atividade default: true pontoApoio: type: object allOf: – #/definitions/pontoApoioRec description: Ponto de apoio da filial (caso a filial tenha) responses: 200: description: Ok schema: type: object required: – ok – dsErro – erros – listaNaoInseridas – listaInseridas – listaAtividadesJaInseridas – cdRoteirizacao properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso. dsErro: type: array items: type: string minimum: 1 description: Descrição do erro ocorrido. DEPRECADO: utilizar variavel erros. erros: type: array items: type: object allOf: – #/definitions/mensagemRec minimum: 1 description: Mensagens de erro, caso ocorram. listaNaoInseridas: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Atividades que não obtiveram êxito na operação. listaInseridas: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Atividades que obtiveram êxito na operação. listaAtividadesJaInseridas: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Atividades já inseridas – Atividades que já foram inseridas, porém ignoradas. cdRoteirizacao: type: integer format: int64 description: Código da roteirização gerada caso tenha sido informado os dados de rotas. cdRoteiros: type: array items: type: integer format: int64 description: Lista de roteiros. cdImportacao: type: integer format: int64 description: Código da importação idPontoApoio: type: integer format: int64 description: Código identificador do Ponto de apoio temRoteirizacao: type: boolean description: Indica que irá roteirizar as atividades importadas default: false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/integraAtividades: post: description: Cadastro de Atividades em Lote: Recomendado para integrações. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – atividades properties: atividades: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Atividades a serem gravas. Caso possuam o campo RefRota preenchido, será gerado um roteiro para a atividade. usuario: type: string description: E-mail do usuário que será notificado na plataforma Senior X assim que o processo de geocodificação das atividades que foram inseridas for concluído. inOutputErro: type: integer format: int64 description: 1- Todos os erros em dsErro e em erros. 2- Todos os erros em dsErro, 3- Todos os erros em erros. Padrão: 1 inSitRotNovo: type: integer format: int64 description: Situação em que os novos roteiros estarão. Padrão: 1 (confirmado) importacao: type: object allOf: – #/definitions/importacaoRec description: Importação qtDiasRoteirizacao: type: integer format: int64 description: Quantidade de Dias para Roteirização qtTempoAtendPad: type: string format: date-time description: atualizaFilialVeiculoExistente: type: boolean description: Indica que a filial do veículo já cadastrado será atualizada conforme a filial informada na atividade default: true pontoApoio: type: object allOf: – #/definitions/pontoApoioRec description: Ponto de apoio da filial (caso a filial tenha) responses: 200: description: Ok schema: type: object required: – ticket – ok – dsErro properties: ticket: type: integer format: int64 description: Código da importação gerada ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Mensagem de Erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraAtividade: post: description: Edicao de Atividade – descontinuada – utilizar alteraAtividades tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade – inAtividade – dsDestinatario – dsNrDocto properties: nrCNPJFilial: type: string description: Código identificador da filial cdAtividade: type: integer format: int64 description: Código da atividade inAtividade: type: integer format: int64 description: Tipo da Atividade. Ex: Coleta, Entrega. cdDestino: type: string description: Código do Destino (serviço empresas) dsDestinatario: type: string description: Destinatário da atividade dsLocal: type: string description: Local (endereço) onde a atividade será realizada cdNumero: type: integer format: int64 description: Número do (endereço) onde a atividade será realizada dsComplemento: type: string description: Descrição (endereço) onde a atividade será realizada dsBairro: type: string description: Bairro (endereço) onde a atividade será realizada dsCidade: type: string description: Município (endereço) onde a atividade será realizada dsEstado: type: string description: Estado (endereço) onde a atividade será realizada dsPais: type: string description: País (endereço) onde a atividade será realizada qtVolumes: type: number format: double description: Quantidade de volumes referentes a atividade. Ex: Coleta de 2 volumes. qtPeso: type: number format: double description: Peso total dos volumes da atividade. Ex: 5.000,00 kg hrLimite: type: string format: date-time description: Horário limite para coletas dsNrDocto: type: string description: Número do documento (romaneio, nf, etc.) dtPrazoEntr: type: string format: date-time description: Data do Prazo de Entrega dsLat: type: string description: Latitude geográfica dsLong: type: string description: Longitudade geográfica nrCep: type: integer format: int64 description: CEP do local da atividade dtJanelaIni: type: string format: date-time description: Janela de data e hora início dtJanelaFim: type: string format: date-time description: Janela de data e hora Fim qtTempoAtend: type: string format: date-time description: Tempo de atendimento em horas/minutos(hh:mm) qtMetrosCubicos: type: number format: double description: Quantidade em metros cúbicos inPrioridade: type: integer format: int64 description: Prioridade: campo numérico nrTelefoneContato: type: string description: Telefone de contato do cliente: campo opcional cdRoteirizacao: type: integer format: int64 description: Caso esteja realizando edicao a partir de uma roteirizacao, informar o codigo da roteirizacao cdTipoCarga: type: integer format: int64 description: Tipo de Carga cdEspCarga: type: integer format: int64 description: Código identificador da Espécie de Carga cdOperacao: type: integer format: int64 description: Operação dsObservacao: type: string description: Observação dtAgendamento: type: string format: date-time description: Data utilizada para apresentar ou não atividade durante seleção na roteirização cdEmbarcador: type: string description: Código do embarcador inDocto: type: integer format: int64 description: Tipo de documento vlMercadoria: type: number format: double description: Valor da Mercadoria default: 0.0 responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Mensagem de Erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraAtividades: post: description: Edicao de Atividades tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – atividades properties: inModTransp: type: integer format: int64 description: tipo de modalidade de transporte atividades: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaOk – listaNOK properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: array items: type: string minimum: 1 description: Mensagem de Erro listaOk: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Ocorrencias em que a operacao teve sucesso listaNOK: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Ocorrencias em que a operacao nao teve sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaAtividade: post: description: Exclusao de Atividade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade properties: cdAtividade: type: integer format: int64 description: Código identificador da atividade responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Mensagem de Erro atividade: type: object allOf: – #/definitions/MCEATVRec description: atividade excluida 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaAtividades: post: description: Exclusão de atividades. Permite exclusão parcial. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividades properties: cdAtividades: type: array items: type: integer format: int64 minimum: 1 description: Lista de códigos de atividade responses: 200: description: Ok schema: type: object required: – atividadesExcluidas – atividadesNaoExcluidas properties: atividadesExcluidas: type: array items: type: integer format: int64 minimum: 1 description: Lista de códigos das atividades excluídas com sucesso atividadesNaoExcluidas: type: array items: type: object allOf: – #/definitions/recAtividadeNaoExcluida minimum: 1 description: Lista com o código e o motivo da não exclusão de cada atividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/executaVinculacaoAtividadesSemRegiao: post: description: Executar Roteiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filiais properties: filiais: type: array items: type: string minimum: 1 description: Código identificador da filial responses: 200: description: Ok schema: type: object required: – dsErro properties: ok: type: boolean description: Retorna verdadeiro se sucesso, ou false se for erro default: true dsErro: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereOperacao: post: description: Cadastro de Operações tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filiais properties: cdOperacao: type: integer format: int64 description: Código identificador da Operação cdReferencia: type: string description: Campo alfanumérico para refência do código no sistema legado dsOperacao: type: string description: Descrição da Operação filiais: type: array items: type: string minimum: 1 description: Lista com o CNPJ de filiais responses: 200: description: Ok schema: type: object required: – ok – cdOperacao – dsErro properties: ok: type: boolean description: Confirmação de retorno com sucesso cdOperacao: type: integer format: int64 description: código da operação gerada dsErro: type: string description: Descrição do erro caso não ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraOperacao: post: description: Alteração de Operações tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdOperacao – filiais properties: cdOperacao: type: integer format: int64 description: Código identificador da Operacao cdReferencia: type: string description: Campo alfanumérico para refência do código no sistema legado dsOperacao: type: string description: Descrição da Operação filiais: type: array items: type: string minimum: 1 description: Lista com o CNPJ de filiais responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Confirmação de retorno com sucesso dsErro: type: string description: Descrição do erro caso não ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaOperacao: post: description: Exclusao de Operações tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdOperacao properties: cdOperacao: type: integer format: int64 description: Código identificador da operação responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Mensagem de Erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereTipoCarga: post: description: Cadastro de Tipos de Carga tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filiais properties: cdTipoCarga: type: integer format: int64 description: Código identificador do Tipo de Carga cdReferencia: type: string description: Campo alfanumérico para refência do código no sistema legado dsTipoCarga: type: string description: Descrição do Tipo de Carga cdEspecie: type: integer format: int64 description: Código da espécie da carga filiais: type: array items: type: string minimum: 1 description: Lista com o CNPJ de filiais inPrioridadeMaxima: type: boolean description: Indica se atividades vinculadas a este tipo de carga devem ser priorizadas durante roteirizações. Exemplo: hortifruti. Por padrão o tipo de carga não é prioritário. default: false responses: 200: description: Ok schema: type: object required: – ok – cdTipoCarga – dsErro properties: ok: type: boolean description: Confirmação de retorno com sucesso cdTipoCarga: type: integer format: int64 description: código do tipo de carga gerada dsErro: type: string description: Descrição do erro caso não ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraTipoCarga: post: description: Alteração de Tipo de Carga tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdTipoCarga – filiais properties: cdTipoCarga: type: integer format: int64 description: Código identificador do Tipo de Carga cdReferencia: type: string description: Campo alfanumérico para refência do código no sistema legado dsTipoCarga: type: string description: Descrição do Tipo de Carga cdEspecie: type: integer format: int64 description: Código da espécie da carga filiais: type: array items: type: string minimum: 1 description: Lista com o CNPJ de filiais inPrioridadeMaxima: type: boolean description: Indica se atividades vinculadas a este tipo de carga devem ser priorizadas durante roteirizações. Exemplo: hortifruti. Caso não informado, o valor atual será mantido responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Confirmação de retorno com sucesso dsErro: type: string description: Descrição do erro caso não ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaTipoCarga: post: description: Exclusao de Tipo de Carga tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdTipoCarga properties: cdTipoCarga: type: integer format: int64 description: Código identificador do Tipo de Carga responses: 200: description: Ok schema: type: object properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso default: true dsErro: type: string description: Mensagem de Erro default: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaPergunta: post: description: Deleta Pergunta – Checklist de entregas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: UUID do registro responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/inserePergunta: post: description: Cadastro de Pergunta – Checklist de entregas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – descricao – obrigatorio – tipoResposta properties: referencia: type: string description: Campo referência para controle deperguntas por parte do usuário descricao: type: string description: Descrição da pergunta obrigatorio: type: boolean description: Obrigatorio responder a pergunta tipoResposta: type: string allOf: – #/definitions/enumTipoResposta description: Tipo de resposta tamanhoMinimo: type: integer format: int64 description: Tamanho mínimo da pergunta tamanhoMaximo: type: integer format: int64 description: Tamanho máximo da pergunta responses: 200: description: Ok schema: type: object required: – pergunta properties: pergunta: type: object allOf: – #/definitions/recPergunta description: Lista de perguntas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraPergunta: post: description: Alteração de Pergunta – Checklist de entregas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – descricao – obrigatorio – tipoResposta – ativo properties: id: type: string description: UUID do registro referencia: type: string description: Campo referência para controle deperguntas por parte do usuário descricao: type: string description: Descrição da pergunta obrigatorio: type: boolean description: Obrigatorio responder a pergunta tipoResposta: type: string allOf: – #/definitions/enumTipoResposta description: Tipo de resposta tamanhoMinimo: type: integer format: int64 description: Tamanho mínimo da pergunta tamanhoMaximo: type: integer format: int64 description: Tamanho máximo da pergunta ativo: type: boolean description: Ativo responses: 200: description: Ok schema: type: object required: – pergunta properties: pergunta: type: object allOf: – #/definitions/recPergunta description: Lista de perguntas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereEspecieCarga: post: description: Cadastro de Espécies de Carga tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dsEspecie properties: cdEspCarga: type: integer format: int64 description: Código identificador da Espécie de Carga dsEspecie: type: string description: Descrição da Espécie de Carga dsAbreviacao: type: string description: Abreviação da espécie da carga responses: 200: description: Ok schema: type: object required: – cdEspCarga properties: ok: type: boolean description: Confirmação de retorno com sucesso default: true dsErro: type: string description: Descrição do erro caso não ok default: cdEspCarga: type: integer format: int64 description: código da espécie de carga gerada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraEspecieCarga: post: description: Alteração de Espécie de Carga tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdEspCarga: type: integer format: int64 description: Código identificador da Espécie de Carga dsEspecie: type: string description: Descrição da Espécie de Carga dsAbreviacao: type: string description: Abreviação da espécie da carga responses: 200: description: Ok schema: type: object properties: ok: type: boolean description: Confirmação de retorno com sucesso default: true dsErro: type: string description: Descrição do erro caso não ok default: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaEspecieCarga: post: description: Exclusão de Espécie de Carga tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdEspCarga properties: cdEspCarga: type: integer format: int64 description: Código identificador da Espécie de Carga responses: 200: description: Ok schema: type: object properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso default: true dsErro: type: string description: Mensagem de Erro default: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereOcorrencias: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ocorrencias properties: ocorrencias: type: array items: type: object allOf: – #/definitions/MCEATVMVRec minimum: 1 description: cdVersaoApp: type: integer format: int64 description: Versão instalada do aplicativo móvel utilizada no dispositivo que realizou o envio responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaOk – listaNOK properties: ok: type: boolean description: Identificador de sucesso na operacao dsErro: type: array items: type: string minimum: 1 description: Mensagem de erro da operacao, caso ocorra listaOk: type: array items: type: object allOf: – #/definitions/MCEATVMVRec minimum: 1 description: Ocorrencias em que a operacao teve sucesso listaNOK: type: array items: type: object allOf: – #/definitions/MCEATVMVRec minimum: 1 description: Ocorrencias em que a operacao nao teve sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/inutilizaAtividade: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoAtividade – codigoOcorrencia properties: codigoAtividade: type: integer format: int64 description: Código da atividade codigoOcorrencia: type: integer format: int64 description: Código da ocorrência responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Identificador de sucesso na operacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/confirmarUploadFotoOcorrencia: post: description: Confirma a gravação do arquivo no serviço na versão em que ocorreu o upload tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade – cdSeqOcorrencia – id – nomeAnexo – versao properties: cdAtividade: type: integer format: int64 description: Código da Atividade cdSeqOcorrencia: type: integer format: int64 description: Código da Sequência da Ocorrência id: type: string description: id unico do arquivo no serviço nomeAnexo: type: string description: nome do anexo versao: type: string description: versão do anexo (obtida no retorno da primitiva obterUrlUploadAnexo) responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereAssinaturaOcorrencia: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade – cdSeqOcorrencia – dsImgAssinatura properties: cdAtividade: type: integer format: int64 description: cdSeqOcorrencia: type: integer format: int64 description: dsImgAssinatura: type: string format: byte description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereRestricaoRegiao: post: description: Inserção de restrições em determinada região tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – restricoes properties: restricoes: type: array items: type: object allOf: – #/definitions/recRestricaoRegiao minimum: 1 description: Lista com as vinculações a serem inseridas responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaOk properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaOk: type: array items: type: object allOf: – #/definitions/recRestricaoRegiao minimum: 1 description: Lista de restrições que foram inseridos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaRestricaoRegiao: post: description: Exclusão de restrições de determinada região tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – restricoes properties: restricoes: type: array items: type: object allOf: – #/definitions/recRestricaoRegiao minimum: 1 description: Lista com as vinculações a serem excluídas responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaRestricaoTipoCarga: post: description: Exclusão de restrições de determinada região tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – restricoes properties: restricoes: type: array items: type: object allOf: – #/definitions/recTipoCarga minimum: 1 description: Lista com as vinculações a serem excluídas responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereRestricaoTipoCarga: post: description: Inserção de restrições de tipo de carga tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – restricoes properties: restricoes: type: array items: type: object allOf: – #/definitions/recTipoCarga minimum: 1 description: Lista com as vinculações a serem inseridas responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaOk properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaOk: type: array items: type: object allOf: – #/definitions/recTipoCarga minimum: 1 description: Lista de restrições que foram inseridos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereRestricaoOperacao: post: description: Inserção de restrições em determinada operacao tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – restricoes properties: restricoes: type: array items: type: object allOf: – #/definitions/recRestricaoOperacao minimum: 1 description: Lista com as vinculações a serem inseridas responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaOk properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaOk: type: array items: type: object allOf: – #/definitions/recRestricaoOperacao minimum: 1 description: Lista de restrições que foram inseridos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaRestricaoOperacao: post: description: Exclusão de restrições de determinada operacao tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – restricoes properties: restricoes: type: array items: type: object allOf: – #/definitions/recRestricaoOperacao minimum: 1 description: Lista com as vinculações a serem excluídas responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereLocalizacaoVeiculo: post: description: Inserção da localização do veículo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – localizacoes properties: localizacoes: type: array items: type: object allOf: – #/definitions/localizacaoVeicRec minimum: 1 description: Lisa de localizações a serem inseridas cdVersaoApp: type: integer format: int64 description: Versão instalada do aplicativo móvel utilizada no dispositivo que realizou o envio cdRoteiro: type: integer format: int64 description: Roteiro ao qual as ocorrências percentecem responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaResultado: type: array items: type: object allOf: – #/definitions/localizacaoVeicRec minimum: 1 description: Lista de resultado com as localizações inseridas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereTipoCargaIncompativel: post: description: Inserção de tipos de carga incompativeis tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tiposCarga properties: tiposCarga: type: array items: type: object allOf: – #/definitions/recTipoCarga minimum: 1 description: Lista com as vinculações a serem inseridas responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaOk properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro listaOk: type: array items: type: object allOf: – #/definitions/recTipoCarga minimum: 1 description: Lista de tipos de carga incompatíveis que foram inseridos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaTipoCargaIncompativel: post: description: Exclusao de Tipo de Carga Incompativel tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tiposCarga properties: tiposCarga: type: array items: type: object allOf: – #/definitions/recTipoCarga minimum: 1 description: lista de Código identificador do Tipo de Carga incompatível para exlusão responses: 200: description: Ok schema: type: object properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso default: true dsErro: type: string description: Mensagem de Erro default: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/inicializaStatusAtividadesPadrao: post: description: Utilizado pelo frontend para atualizar atividades com Status não informado para 2-Aprovada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Resultado da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/classificaStatusAtividades: post: description: Altera aceite de atividades conforme destino e regras da filial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: atividades: type: array items: type: integer format: int64 description: Lista de códigos de atividades, separados por vírgula inDetalhes: type: boolean description: Detalhes, lista o registro da atividade, destino e regra da filial aplicada para obter o Status (0-Recusada, 1-Em Análise, 2-Aprovada) responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Mensagem de erro atividades: type: array items: type: object allOf: – #/definitions/recAtvClassificada description: Atividades que fizeram parte do processo de classificação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraStatusAtividade: post: description: Altera Situação da Atividade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade – inStatus properties: cdAtividade: type: integer format: int64 description: Código da atividade a sofrer alteração inStatus: type: integer format: int64 description: Status de aceite da atividade, podendo ser: 0-Recusada, 1-Em Análise ou 2-Aceita responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Mensagem de erro ocorrido 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereHorarioRestricao: post: description: Inserção da faixa de horário e dia da semana da restrição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – horariosRestricao properties: horariosRestricao: type: object allOf: – #/definitions/recHorariosRestricao description: Dados a serem inseridos responses: 200: description: Ok schema: type: object required: – dsErro – ok – cdHorario properties: dsErro: type: string description: Caso tenha ocorrido algum erro, a mensagem será retornada ok: type: boolean description: False em caso de erro cdHorario: type: integer format: int64 description: Retorna o código da faixa de horário gerada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraHorarioRestricao: post: description: Atualização da faixa de horário e dia da semana da restrição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – horariosRestricao properties: horariosRestricao: type: object allOf: – #/definitions/recHorariosRestricao description: Dados a serem alterados responses: 200: description: Ok schema: type: object required: – dsErro – ok properties: dsErro: type: string description: Caso tenha ocorrido algum erro, a mensagem será retornada ok: type: boolean description: False em caso de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/excluiHorarioRestricao: post: description: Exclusão da faixa de horário e dia da semana da restrição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRegiao: type: integer format: int64 description: Código da região cdRestricao: type: integer format: int64 description: Código da restrição cdHorario: type: integer format: int64 description: Código do horário a ser excluída, quando não informado todos os horários da determinada restrição serão excluídos responses: 200: description: Ok schema: type: object required: – dsErro – ok properties: dsErro: type: string description: Caso tenha ocorrido algum erro, a mensagem será retornada ok: type: boolean description: False em caso de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereEmbarcadores: post: description: cadastra embarcador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – embarcadores properties: embarcadores: type: array items: type: object allOf: – #/definitions/MCEEMBrec minimum: 1 description: lista de embarcadores responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaNOK – listaOk properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: array items: type: string minimum: 1 description: Descrição do erro ocorrido. listaNOK: type: array items: type: object allOf: – #/definitions/MCEEMBrec minimum: 1 description: Destinos que não obtiveram êxito na operação. listaOk: type: array items: type: object allOf: – #/definitions/MCEEMBrec minimum: 1 description: Destinos que obtiveram êxito na operação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaEmbarcador: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdEmbarcador properties: cdEmbarcador: type: string description: código do embarcadore responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro ocorrido. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraEmbarcadores: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – embarcadores properties: embarcadores: type: array items: type: object allOf: – #/definitions/MCEEMBrec minimum: 1 description: lista de embarcadores responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaNOK – listaOk properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: array items: type: string minimum: 1 description: Descrição do erro ocorrido. listaNOK: type: array items: type: object allOf: – #/definitions/MCEEMBrec minimum: 1 description: Destinos que não obtiveram êxito na operação. listaOk: type: array items: type: object allOf: – #/definitions/MCEEMBrec minimum: 1 description: Destinos que obtiveram êxito na operação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereImportacao: post: description: Insere uma nova importação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inImportacao – dsEntrada – dtInicio – dsUsuario properties: dsImportacao: type: string description: Descrição da importação inImportacao: type: integer format: int64 description: Tipo da importação dsEntrada: type: string description: Entrada da importacao dtInicio: type: string format: date-time description: Data inicial da importacao dtFim: type: string format: date-time description: Data final da importacao dsUsuario: type: string description: Usuário que executou a importação dsRefRoteiros: type: string description: Lista de referências de roteiros informados nas atividades da importação, separados por vírgula. Ex: 1-135-1,1-136-1 responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro resultado: type: object allOf: – #/definitions/importacaoRec description: Dados do registro inserido 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraImportacao: post: description: Atualiza uma importação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdImportacao – inImportacao properties: cdImportacao: type: integer format: int64 description: Código da importação dsImportacao: type: string description: Descrição da importação inImportacao: type: integer format: int64 description: Tipo da importação dsEntrada: type: string description: Entrada da importacao dtInicio: type: string format: date-time description: Data inicial da importacao dtFim: type: string format: date-time description: Data final da importacao dsUsuario: type: string description: Usuário que executou a importação dsRefRoteiros: type: string description: Lista de referências de roteiros informados nas atividades da importação, separados por vírgula. Ex: 1-135-1,1-136-1 inSucesso: type: integer format: int64 description: Sucesso da operação: 0 = Erro, 1 = Sucesso cdRoteirizacao: type: integer format: int64 description: Código da roteirização gerado na importação, quando aplicável cdRoteiros: type: string description: Lista de códigos de roteiros separados por vírgula. Ex: 1,2,3 atividadesInseridas: type: string description: Código das atividades inseridas, separados por vírgula. Ex: 1,2,3 referenciasNaoInseridas: type: string description: Referência das das atividades não inseridas, separados por vírgula. Ex: 1,2,3 dsErro: type: string description: Caso tenham ocorrido erros na importação responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro resultado: type: object allOf: – #/definitions/importacaoRec description: Dados do registro alterado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaImportacao: post: description: Deleta uma importação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdImportacao properties: cdImportacao: type: integer format: int64 description: Código da importação responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro resultado: type: object allOf: – #/definitions/importacaoRec description: Dados do registro excluído 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereImportacaoLog: post: description: Insere um log de importação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdImportacao properties: cdImportacao: type: integer format: int64 description: Código da importação dsErro: type: string description: Descrição do erro ocorrido dsItens: type: string description: Itens que causaram o erro dtLog: type: string format: date-time description: Data do log responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro resultado: type: object allOf: – #/definitions/importacaoLogRec description: Dados do registro inserido 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraImportacaoLog: post: description: Atualiza um log de importação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdLog properties: cdLog: type: integer format: int64 description: Código do log cdImportacao: type: integer format: int64 description: Código da importação dsErro: type: string description: Descrição do erro ocorrido dsItens: type: string description: Itens que causaram o erro dtLog: type: string format: date-time description: Data do log responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro resultado: type: object allOf: – #/definitions/importacaoLogRec description: Dados do registro alterado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaImportacaoLog: post: description: Deleta um log de importação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdLog properties: cdLog: type: integer format: int64 description: Código do log responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro resultado: type: object allOf: – #/definitions/importacaoLogRec description: Dados do registro excluído 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereComposicao: post: description: Cadastro de Composição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial – dsNrComposicao properties: nrCNPJFilial: type: string description: Código identificador da filial dsNrComposicao: type: string description: Número da composição inPrioridade: type: integer format: int64 description: Prioridade: campo numérico cdTipoCarga: type: integer format: int64 description: Tipo de Carga cdEspCarga: type: object allOf: – #/definitions/MCEESPCARRec description: Especie de Carga cdOperacao: type: integer format: int64 description: Operação dsObservacao: type: string description: Observação cdEmbarcador: type: string description: Código do embarcador inLiberado: type: integer format: int64 description: Status de liberação da composição responses: 200: description: Ok schema: type: object required: – ok – dsErro – composicao properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Descrição do Erro caso não ok composicao: type: object allOf: – #/definitions/PVICOMPRec description: Composição inserida 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraComposicoes: post: description: Edição de Composição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – composicoes properties: composicoes: type: array items: type: object allOf: – #/definitions/PVICOMPRec minimum: 1 description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaOk – listaNOK properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: array items: type: string minimum: 1 description: Mensagem de Erro listaOk: type: array items: type: object allOf: – #/definitions/PVICOMPRec minimum: 1 description: Ocorrencias em que a operacao teve sucesso listaNOK: type: array items: type: object allOf: – #/definitions/PVICOMPRec minimum: 1 description: Ocorrencias em que a operacao nao teve sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaComposicao: post: description: Exclusao de Composição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdComposicao properties: cdComposicao: type: integer format: int64 description: Código identificador da composição responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Mensagem de Erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/executarPrimeiroAcesso: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraChaveAcesso: post: description: Permite alterar/informar a chave de acesso do documento de uma atividade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdAtividade: type: integer format: int64 description: Opção de identificação de atividade 1 nrCNPJFilial: type: string description: Opção de identificação de atividade 2 inAtividade: type: integer format: int64 description: Opção de identificação de atividade 2 cdEmbarcador: type: string description: Opção de identificação de atividade 2 dsNrDocto: type: string description: Opção de identificação de atividade 2 inDoctoAtual: type: integer format: int64 description: Opção de identificação de atividade 2 cdChaveAcessoAtual: type: string description: Opção de identificação de atividade 3 inDoctoNovo: type: integer format: int64 description: Tipo de documento a ser informado na atividade cdChaveAcessoNova: type: string description: Chave de acesso a ser informada na atividade responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: dsErro: type: string description: resultado: type: object allOf: – #/definitions/MCEATVRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraColeta: post: description: Endpoint responsável por alterar coleta com vínculo a uma rota tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigo – cnpj – destinatario – local – bairro – cidade – estado – pais properties: codigo: type: integer format: int64 description: Código da atividade codigoDestino: type: string description: Código de destino da coleta cnpj: type: string description: Número do CNPJ Filial destinatario: type: string description: Destinatário da coleta local: type: string description: Endereço da coleta numero: type: integer format: int64 description: Número endereço da coleta complemento: type: string description: Complemento do endereço da coleta bairro: type: string description: Bairro da coleta cidade: type: string description: Cidade da coleta estado: type: string description: Estado da coleta pais: type: string description: Pais da coleta cep: type: integer format: int64 description: Informação de cep da coleta latitude: type: string description: Informação de latitude da coleta longitude: type: string description: Informação de longitude da coleta volumes: type: number format: double description: Informação de volume da coleta peso: type: number format: double description: Informação de peso da coleta telefoneContato: type: string description: Informação de telefone de contato da coleta metrosCubicos: type: number format: double description: Informação de metros cúbicos da coleta codigoTipoCarga: type: integer format: int64 description: Código de carga da coleta codigoOperacao: type: integer format: int64 description: Código de operação da coleta observacao: type: string description: Observação de carga da coleta valorMercadoria: type: number format: double description: Valor da mercadoria dataAgendamento: type: string format: date-time description: Data do agendamento da coleta dtPrazoEntr: type: string format: date-time description: Data do prazo da coleta responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Indica se alteração da coleta foi com sucesso ou não dsErro: type: string description: Apresenta a mensagem de erro caso tenha 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereQuestionario: post: description: Cadastro de questionário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – descricao properties: descricao: type: string description: Descrição do questionário responses: 200: description: Ok schema: type: object required: – codigo properties: codigo: type: integer format: int64 description: Código identificador do questionário cadastrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraQuestionario: post: description: Edição de questionário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigo – descricao – ativo properties: codigo: type: integer format: int64 description: Código identificador do questionário descricao: type: string description: Descrição do questionário ativo: type: boolean description: Ativo responses: 200: description: Ok schema: type: object required: – codigo properties: codigo: type: integer format: int64 description: Código identificador do questionário cadastrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaQuestionario: post: description: Remove o questionário e vinculações a perguntas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigo properties: codigo: type: integer format: int64 description: Código identificador do questionário responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereRegraQuestionario: post: description: Cadastro de Regras de questionário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – descricao – questionario properties: descricao: type: string description: Descrição da regra de questionário ocorrencia: type: integer format: int64 description: Código da Ocorrencia tipoCarga: type: integer format: int64 description: Código do Tipo de carga especieCarga: type: integer format: int64 description: Código da Espécie de carga questionario: type: integer format: int64 description: Código do Questionário responses: 200: description: Ok schema: type: object required: – codigo properties: codigo: type: integer format: int64 description: Código identificador do questionário cadastrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/alteraRegraQuestionario: post: description: Edição de regra de questionário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigo – descricao – questionario – ativo properties: codigo: type: integer format: int64 description: Código identificador da regra de questionário descricao: type: string description: Descrição da regra de questionário ocorrencia: type: integer format: int64 description: Código da Ocorrencia tipoCarga: type: integer format: int64 description: Código do Tipo de carga especieCarga: type: integer format: int64 description: Código da Espécie de carga questionario: type: integer format: int64 description: Código do Questionário ativo: type: boolean description: Ativo responses: 200: description: Ok schema: type: object required: – codigo properties: codigo: type: integer format: int64 description: Código identificador do questionário cadastrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaRegraQuestionario: post: description: Remove o questionário e vinculações a perguntas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigo properties: codigo: type: integer format: int64 description: Código identificador da regra de questionário responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/inserePerguntaQuestionario: post: description: Vincula uma pergunta a um questionário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoQuestionario – idPergunta properties: codigoQuestionario: type: integer format: int64 description: Código identificador do questionário idPergunta: type: string description: UUID das perguntas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/deletaPerguntaQuestionario: post: description: Remove a vinculação entre uma pergunta e um questionário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoQuestionario – idPergunta properties: codigoQuestionario: type: integer format: int64 description: Código identificador do questionário idPergunta: type: string description: UUID da pergunta responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/atualizaPerguntasQuestionario: post: description: Atualiza perguntas de um questionário – deleta existentes e insere as informadas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoQuestionario properties: codigoQuestionario: type: integer format: int64 description: Código identificador do questionário idPerguntas: type: array items: type: string description: UUID das perguntas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/insereGrauParentesco: post: description: Primitiva para inserir um grau de parentesco tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – descricao properties: descricao: type: string description: Descrição do grau de parentesco responses: 200: description: Ok schema: type: object required: – grauParentesco properties: grauParentesco: type: object allOf: – #/definitions/GrauParentescoRec description: Retorna grau parentesco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/atualizaGrauParentesco: post: description: Primitiva que altera um grau de parentesco tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – descricao – ativo properties: id: type: integer format: int64 description: Id grau de parentesco descricao: type: string description: Descricao do grau de parentesco ativo: type: boolean description: Indica se o grau parentesco está ativo/inativo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/forcePublishEvent: post: description: Publica evento do serviço, afim de que os serviços subjacentes consigam processar o evento\nNecessário permissão master no recurso/ação res://senior.com.br/tmsentregas/atividades/gestaoEnvioIntegracao / Reenviar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – eventName – tenantName properties: eventName: type: string allOf: – #/definitions/enumEventoPublicacao description: Evento que será publicado filter: type: string description: Filtro dos registros que serão publicados tenantName: type: string description: Tenant responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Objeto não encontrado default: description: Error response schema: #/definitions/genericError /atividades/actions/forcePublishEventTenant: post: description: Publica evento do serviço, afim de que os serviços subjacentes consigam processar o evento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – eventName properties: eventName: type: string allOf: – #/definitions/enumEventoPublicacao description: Evento que será publicado filter: type: string description: Filtro dos registros que serão publicados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/actions/relatorioMovimentacao: post: description: Relatório de atividade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filial – dataInclusaoInicial – dataInclusaoFinal – tipoArquivo properties: filial: type: array items: type: string minimum: 1 description: CPNJ da filial ou filiais que deseja gerar o relatório dataInclusaoInicial: type: string format: date-time description: Data inclusão da atividade, será utilizada como data inicial do relatório dataInclusaoFinal: type: string format: date-time description: Data inclusão da atividade, será utilizada como data final do relatório tipoArquivo: type: string description: Tipo do arquivo que será exportado (csv, xls, xlsx) responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /atividades/events/atividadeInserida: post: description: Informa que uma atividade foi inserida x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – atividade – ok – dsErro properties: atividade: type: object allOf: – #/definitions/MCEATVRec description: atividade inserida ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Descrição do Erro caso não ok responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /atividades/events/atividadeRecusada: post: description: Informa que uma atividade foi recusada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – atividade – ok – dsErro properties: atividade: type: object allOf: – #/definitions/MCEATVRec description: atividade recusada ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Descrição do Erro caso não ok responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /atividades/events/atividadeExcluida: post: description: Informa que uma atividade foi excluída x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – atividade – ok – dsErro properties: atividade: type: object allOf: – #/definitions/MCEATVRec description: atividade excluída ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Mensagem de Erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /atividades/events/atividadesLoteInseridas: post: description: Informa que foram inseridas atividades em lote x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ok – erros – listaNaoInseridas – listaInseridas properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso. erros: type: array items: type: object allOf: – #/definitions/mensagemRec minimum: 1 description: Mensagens de erro, caso ocorram. listaNaoInseridas: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Atividades que não obtiveram êxito na operação. listaInseridas: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Atividades que obtiveram êxito na operação. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /atividades/events/ocorrenciasRealizadas: post: description: Informa que foi realizada ocorrência x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ok – dsErro – listaOk – listaNOK – ws_users properties: ok: type: boolean description: Identificador de sucesso na operacao dsErro: type: array items: type: string minimum: 1 description: Mensagem de erro da operacao, caso ocorra listaOk: type: array items: type: object allOf: – #/definitions/MCEATVMVRec minimum: 1 description: Ocorrencias em que a operacao teve sucesso listaNOK: type: array items: type: object allOf: – #/definitions/MCEATVMVRec minimum: 1 description: Ocorrencias em que a operacao nao teve sucesso ws_users: type: string description: Usuários que receberão a chamada – websocket responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /atividades/events/fotoOcorrenciaInserida: post: description: Informa que a foto de uma ocorrência foi inserida, buscar a foto utilizando o método buscaDadosRecebedor x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ok – dsErro – cdAtividade – cdSeqOcorrencia – dsNomeArquivo – dsTipoArquivo – idBlobServiceFile properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Descrição do Erro caso não ok cdAtividade: type: integer format: int64 description: código da atividade inserida cdSeqOcorrencia: type: integer format: int64 description: sequência da ocorrência inserida dsNomeArquivo: type: string description: nome do arquivo dsTipoArquivo: type: string description: tipo do arquivo (.jpg) idBlobServiceFile: type: string description: id do arquivo no blob service, para consulta via obterAcessoDownloadFotoOcorrencia – idBlobServiceFile responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /atividades/events/assinaturaOcorrenciaInserida: post: description: Informa que a assinatura de uma ocorrência foi inserida, buscar a assinatura utilizando o método buscaDadosRecebedor x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ok – dsErro – cdAtividade – cdSeqOcorrencia properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: Descrição do Erro caso não ok cdAtividade: type: integer format: int64 description: código da atividade inserida cdSeqOcorrencia: type: integer format: int64 description: sequência da ocorrência inserida responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /atividades/events/atualizaTemposExecucaoOcorrencias: post: description: Atualiza os tempos de execução, transito e distância das ocorrências, além de atribuir a atividade ao trajeto do veículo x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ocorrencias – primitiva properties: ocorrencias: type: array items: type: object allOf: – #/definitions/atualizaTemposOcorrenciaRec minimum: 1 description: atividade excluída primitiva: type: string description: Primitiva responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /atividades/events/integraAtividadesEvent: post: description: Chama a inserção do lote de atividade de forma assíncrona, utilizado em integrações via ERP x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – atividades – primitiva properties: atividades: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Atividades a serem gravas. Caso possuam o campo RefRota preenchido, será gerado um roteiro para a atividade. usuario: type: string description: E-mail do usuário que será notificado na plataforma Senior X assim que o processo de geocodificação das atividades que foram inseridas for concluído. inOutputErro: type: integer format: int64 description: 1- Todos os erros em dsErro e em erros. 2- Todos os erros em dsErro, 3- Todos os erros em erros. Padrão: 1 inSitRotNovo: type: integer format: int64 description: Situação em que os novos roteiros estarão. Padrão: 1 (confirmado) importacao: type: object allOf: – #/definitions/importacaoRec description: qtDiasRoteirizacao: type: integer format: int64 description: qtTempoAtendPad: type: string format: date-time description: primitiva: type: string description: Primitiva atualizaFilialVeiculoExistente: type: boolean description: Indica que a filial do veículo já cadastrado será atualizada conforme a filial informada na atividade default: true pontoApoio: type: object allOf: – #/definitions/pontoApoioRec description: Ponto de apoio da filial (caso a filial tenha) responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /atividades/events/roteirizarManualmenteAtividadesIntegracao: post: description: Evento para realização de roteirização manual x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial – usuario – roteiros – veiculos – qtDiasRoteirizacao – dtRoteirizacao properties: nrCNPJFilial: type: string description: CNPJ da filial cdIntegracao: type: integer format: int64 description: Código da integração que originou a roteirização usuario: type: string description: Usuário responsável pelo início do processo de roteirização roteiros: type: array items: type: object allOf: – #/definitions/roteiroManual minimum: 1 description: Roteiros a serem gerados veiculos: type: array items: type: object allOf: – #/definitions/veiculoRoteiroManual minimum: 1 description: Veículos da roteirização qtDiasRoteirizacao: type: integer format: int64 description: Dias da roteirização diasNaoUteisViagem: type: array items: type: string format: date-time description: Dias não úties a serem desconsiderados dtRoteirizacao: type: string format: date-time description: Data da roteirização inFatorTrafego: type: integer format: int64 description: Fator de Trafegpo: Leve, Moderado ou Intenso qtTempoAtendPad: type: string format: date-time description: Tempo de atendimento padrão inSituacao: type: integer format: int64 description: idPontoApoio: type: integer format: int64 description: código identificador do Ponto de apoio da filial (caso a filial tenha) responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /atividades/events/integracaoComRoteirizacaoFinalizada: post: description: Evento que indica que a integração/importação de atividades com geração de rota foi finalizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial – cdIntegracao – cdRoteirizacao – mensagensErro properties: nrCNPJFilial: type: string description: CNPJ da filial cdIntegracao: type: integer format: int64 description: Código da integração que originou a roteirização cdRoteirizacao: type: integer format: int64 description: Código da roteirização gerada mensagensErro: type: array items: type: string minimum: 1 description: Possíveis mensagens de erro ocorridas no processo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /atividades/events/integracaoInsereLoteAtividadesFinalizada: post: description: Evento que indica que a integração/importação de atividades foi finalizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – cdIntegracao – mensagensErro properties: cdIntegracao: type: integer format: int64 description: Código da integração mensagensErro: type: array items: type: string minimum: 1 description: Possíveis mensagens de erro ocorridas no processo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /atividades/events/obterAtividadesTorre: post: description: Evento que efetiva o retornoAtividadesTorre de forma assíncrona na sua totalidade, evitando que erros comprometam a publicação realizada pela primitiva buscaAtividadesTorre x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – filtros properties: filtros: type: object allOf: – #/definitions/filtrosTorre description: Filtros para retorno da consulta responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /atividades/events/retornoAtividadesTorre: post: description: Evento que retornará as informações para torre de controle x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – listaResultado – pagina – qtdPaginas – totalRegistros properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Lista de Atividades pagina: type: integer format: int64 description: Número da página atual de resultado qtdPaginas: type: integer format: int64 description: Total de páginas encontradas totalRegistros: type: integer format: int64 description: Total de registros encontrados responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: buscaAtividadesOrdenacao: description: O campo para ordenação type: string enum: – cdAtividade – dtPrazoEntr – nrPlaca – cdRoteiro – cdSequencia ordenacao: description: A direção da ordenação type: string enum: – asc – desc statusComposicao: description: Status da composição type: string enum: – COMPOSICAO_NAO_OK – COMPOSICAO_OK statusRoteirizacaoLotacao: description: Status da roteirizacao tipo lotação type: string enum: – NAO_ROTEIRIZADA – EM_ELABORACAO situacaoAtividade: description: Tipo de Situação type: string enum: – EM_ABERTO – EM_ANALISE – EM_ANDAMENTO – BLOQUEADA – ORFA – FINALIZADA enumTipoResposta: description: Enum tipo de respota type: string enum: – NUMERO – TEXTO – SIM_NAO 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 serviceHealthStatus: description: Define o Status do serviço type: string enum: – UP – DOWN 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 enumeradorExigeDadosComplementares: description: Utilizado nos tipo de Ocorrência type: string enum: – NAO_UTILIZA – OPCIONAL – OBRIGATORIO tipoDocumento: description: Tipo do documento type: string enum: – PEDIDO – NFE – NFSE – CTE – PADRAO tipoImagem: description: Tipo de Imagem type: string enum: – URI – BASE64 tipoConclusaoOcorrencia: description: Tipo de Conclusão da Ocorrência type: string enum: – NAO_REALIZADA – REALIZADA – REALIZADA_COM_RESSALVAS – DEVOLVIDA – CANCELADA origemComprovante: description: Origem do comprovante type: string enum: – APP – PLATAFORMA enumEventoPublicacao: description: Eventos publicados pelo serviço type: string enum: – OCORRENCIAS_REALIZADAS – FOTO_OCORRENCIA_INSERIDA – ASSINATURA_OCORRENCIA_INSERIDA enumSituacaoRota: description: Situação da rota type: string enum: – ELABORACAO – CONFIRMADA – EXECUCAO – FINALIZADA 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 recPageRequest: description: Page request type: object properties: offset: type: integer format: int64 description: Página. Para retornar do primeiro registro ao quinto, informa-se offset=0 size=5. Para obter do sexto registro ao décimo, informa-se offset=1&size=5 default: 0 size: type: integer format: int64 description: Quantidade por página default: 10 recAtividadeNaoExcluida: description: Código da atividade não excluída e motivo type: object required: – cdAtividade – dsMotivo properties: cdAtividade: type: integer format: int64 description: Código da atividade dsMotivo: type: string description: Motivo da não exclusão MCEATVRec: description: type: object required: – inAtividade – dsDestinatario – qtPeso – dsNrDocto properties: nrCNPJFilial: type: string description: filial: type: object allOf: – #/definitions/MCEEMPFLRec description: cdAtividade: type: integer format: int64 description: inAtividade: type: integer format: int64 description: dsInAtividade: type: string description: cdDestino: type: string description: dsDestinatario: type: string description: dsLocal: type: string description: dsBairro: type: string description: dsCidade: type: string description: dsEstado: type: string description: dsPais: type: string description: cdNumero: type: integer format: int64 description: dsComplemento: type: string description: qtVolumes: type: number format: double description: qtPeso: type: number format: double description: hrLimite: type: string format: date-time description: dsNrDocto: type: string description: dtPrazoEntr: type: string format: date-time description: Data do Prazo de Entrega. opcional para a modalidade de transporte lotação dsLat: type: string description: dsLong: type: string description: nrCep: type: integer format: int64 description: nrTelefoneContato: type: string description: dtJanelaIni: type: string format: date-time description: dtJanelaFim: type: string format: date-time description: qtTempoAtend: type: string format: date-time description: qtMetrosCubicos: type: number format: double description: inPrioridade: type: integer format: int64 description: cdTipoCarga: type: integer format: int64 description: cdEspCarga: type: integer format: int64 description: cdOperacao: type: integer format: int64 description: dsObservacao: type: string description: ocorrencias: type: array items: type: object allOf: – #/definitions/ocorrenciaRec description: localizacao: type: object allOf: – #/definitions/localizacaoVeicRec description: dtRealizado: type: string format: date-time description: cdRoteiro: type: integer format: int64 description: dsRefRoteiro: type: string description: dtIniRoteiro: type: string format: date-time description: nrCnpjFilialRoteiro: type: string description: inAlteradoEmExecucao: type: integer format: int64 description: Indica se o Roteiro da atividade foi alterado quando status já em execução dtPrevEntr: type: string format: date-time description: cdSeqExecucao: type: integer format: int64 description: cdMotorista: type: integer format: int64 description: rgMotorista: type: string description: cnhMotorista: type: string description: dsMotorista: type: string description: nrCpf: type: string description: nrTelefoneMotorista: type: string description: cdIdentDisp: type: integer format: int64 description: nrPlaca: type: string description: nrPlaca2: type: string description: nrPlaca3: type: string description: nrPlaca4: type: string description: qtKmPlanejada: type: number format: double description: qtTempoAtendimentoPlanejado: type: integer format: int64 description: qtTempoEstimado: type: number format: double description: tipoCarga: type: array items: type: object allOf: – #/definitions/recTipoCarga description: operacao: type: object allOf: – #/definitions/MCEOPERec description: dtAgendamento: type: string format: date-time description: dtInclusao: type: string format: date-time description: cdRoteirizacao: type: integer format: int64 description: Caso esteja realizando edicao a partir de uma roteirizacao, informar o codigo da roteirizacao inStatus: type: integer format: int64 description: Status de Aceite, onde 0-Recusada, 1-Em Análise, 2-Aceita dsMotivo: type: string description: Motivo do status. Ex: Grau mínimo de confiança do endereço não atingido dtPrevChegada: type: string format: date-time description: inIncPosterior: type: integer format: int64 description: qtTempoEstimadoRota: type: number format: double description: qtKmRota: type: number format: double description: qtTempoTotalPrevisto: type: integer format: int64 description: qtTempoTotalRealizado: type: integer format: int64 description: qtTempoExecAtvTransito: type: integer format: int64 description: qtTempoExecAtvAtendimento: type: integer format: int64 description: qtKmPercorrido: type: number format: double description: cdEmbarcador: type: string description: Código do embarcador inDocto: type: integer format: int64 description: código do Tipo de documento dsDocto: type: string description: descrição Tipo de documento cdComposicao: type: integer format: int64 description: Código da composição cdChaveAcesso: type: string description: Chave eletrônica de acesso referente ao documento fiscal representado situacaoTorreControle: type: string allOf: – #/definitions/situacaoAtividadeTorreControle description: Situação da atividade na torre de controle retornaParaOrigem: type: boolean description: Ao gerar rotas manualmente via integração, indica se o veículo vai retornar para a filial de origem após realizar a última atividade. Caso não informado será buscado das definições da filial. Valores: TRUE-volta para a filial de origem; FALSE-termina a rota na última atividade, não calculando tempo/quilometragem de retorno idPontoApoio: type: integer format: int64 description: Código identificador do Ponto de apoio da filial (caso a filial tenha) pontoApoio: type: object allOf: – #/definitions/pontoApoioRec description: Ponto de Apoio vlMercadoria: type: number format: double description: Valor da Mercadoria default: 0.0 inStatusDisponibilidade: type: boolean description: Tipo de Status situacao: type: string allOf: – #/definitions/situacaoAtividade description: Tipo Situação grauPrecisao: type: string description: Grau Precisão raioPrecisao: type: integer format: int64 description: Raio Precisão limites: type: string description: Limites codigoTracking: type: string description: Codigo tracking MCEEMPFLRec: description: type: object properties: cnpj: type: string description: nome: type: string description: localizacao: type: object allOf: – #/definitions/LocalizacaoMCEEMPFL description: qtTempoAlertaAtraso: type: integer format: int64 description: Proximidade de tempo até a previsão de entrega para ficar em alerta no painel em minutos. Ex: 30 minutos LocalizacaoMCEEMPFL: description: type: object properties: latitude: type: string description: longitude: type: string description: PVICOMPRec: description: type: object properties: cdComposicao: type: integer format: int64 description: nrCNPJFilial: type: string description: dsNrComposicao: type: string description: inPrioridade: type: integer format: int64 description: cdTipoCarga: type: integer format: int64 description: dsTipoCarga: type: string description: cdOperacao: type: integer format: int64 description: dsOperacao: type: string description: dsObservacao: type: string description: tipoCarga: type: object allOf: – #/definitions/recTipoCarga description: cdEspCarga: type: object allOf: – #/definitions/MCEESPCARRec description: cdEmbarcador: type: string description: dsEmbarcador: type: string description: inStatusComposicao: type: string allOf: – #/definitions/statusComposicao description: inStatusRoteirizacaoLotacao: type: string allOf: – #/definitions/statusRoteirizacaoLotacao description: atividades: type: array items: type: object allOf: – #/definitions/MCEATVRec description: MCEATVMVRec: description: type: object required: – cdAtividade – cdOcorrencia – dtMovimento – dsUsuario – cdRoteiro properties: cdAtividade: type: integer format: int64 description: cdOcorrencia: type: integer format: int64 description: cdSequencia: type: integer format: int64 description: dtMovimento: type: string format: date-time description: dsComplementoOcorr: type: string description: dsLatitude: type: string description: dsLongitude: type: string description: dtDigitacao: type: string format: date-time description: dsUsuario: type: string description: nrDoctoIdentPessoal: type: string description: nrFoneContato: type: string description: dsContato: type: string description: dsFoto: type: string format: byte description: dsImgAssinatura: type: string format: byte description: cdRoteiro: type: integer format: int64 description: cdVersaoApp: type: integer format: int64 description: dsNrDocto: type: string description: cdChaveAcesso: type: string description: dtPosIni: type: string format: date-time description: peso: type: number format: double description: volume: type: number format: double description: quantidade: type: integer format: int64 description: hodometro: type: number format: double description: idGrauParentesco: type: integer format: int64 description: descricaoGrauParentesco: type: string description: numeroResidencia: type: string description: caixaLacrada: type: boolean description: conferidoSemFalta: type: boolean description: tipoConclusaoOcorrencia: type: string allOf: – #/definitions/tipoConclusaoOcorrencia description: Tipo de Conclusão da Ocorrência. Não deve ser utilizado como valor de entrada, somente saída de dados GrauParentescoRec: description: type: object required: – id – descricao – ativo properties: id: type: integer format: int64 description: descricao: type: string description: ativo: type: boolean description: MCEATVIMRec: description: type: object required: – cdAtividade – cdSeqOcorrencia properties: cdAtividade: type: integer format: int64 description: cdSeqOcorrencia: type: integer format: int64 description: dsArquivo: type: string format: byte description: dsNomeArquivo: type: string description: dsTipoArquivo: type: string description: idBlobServiceFile: type: string description: MCEATVASRec: description: type: object required: – cdAtividade – cdSeqOcorrencia properties: cdAtividade: type: integer format: int64 description: cdSeqOcorrencia: type: integer format: int64 description: dsArquivo: type: string format: byte description: dsNomeArquivo: type: string description: dsTipoArquivo: type: string description: recClassificacaoStatusMotivo: description: type: object required: – inStatus – dsMotivo properties: inStatus: type: integer format: int64 description: dsMotivo: type: string description: inAtividadeRec: description: type: object required: – inAtividade – dsInAtividade properties: inAtividade: type: integer format: int64 description: dsInAtividade: type: string description: inDoctoRec: description: tipo de documento type: object required: – inDocto – dsInDocto properties: inDocto: type: integer format: int64 description: código do tipo de embarcador dsInDocto: type: string description: descrição do tipo de documento recAtvClassificada: description: type: object required: – cdAtividade properties: cdAtividade: type: integer format: int64 description: classificacao: type: object allOf: – #/definitions/recClassificacaoStatusMotivo description: nrCNPJFilial: type: string description: cdDestino: type: string description: atividade: type: object allOf: – #/definitions/MCEATVRec description: destino: type: object allOf: – #/definitions/recDestino description: filial: type: object allOf: – #/definitions/recFilial description: regrasAtend: type: object allOf: – #/definitions/recMCEEMPFLREGR description: ocorrenciaRec: description: type: object required: – cdAtividade – cdRoteiro – cdSequencia – dtMovimento – dsComplementoOcorr – nrDoctoIdentPessoal – nrFoneContato – dsContato – dsLatitude – dsLongitude – dtDigitacao – dsUsuario – cdIdentDisp – tpOcorrencia properties: cdAtividade: type: integer format: int64 description: cdRoteiro: type: integer format: int64 description: cdSequencia: type: integer format: int64 description: dtMovimento: type: string format: date-time description: dsComplementoOcorr: type: string description: nrDoctoIdentPessoal: type: string description: nrFoneContato: type: string description: dsContato: type: string description: dsLatitude: type: string description: dsLongitude: type: string description: dtDigitacao: type: string format: date-time description: dsUsuario: type: string description: cdIdentDisp: type: integer format: int64 description: qtTempoExecAtvTransito: type: integer format: int64 description: qtTempoExecAtvAtendimento: type: integer format: int64 description: qtKmPercorrido: type: number format: double description: tpOcorrencia: type: object allOf: – #/definitions/tpOcorrenciaRec description: motoristaOcorrencia: type: object allOf: – #/definitions/motoristaRec description: placa: type: string description: peso: type: number format: double description: volume: type: number format: double description: quantidade: type: integer format: int64 description: hodometro: type: number format: double description: idGrauParentesco: type: integer format: int64 description: descricaoGrauParentesco: type: string description: numeroResidencia: type: string description: caixaLacrada: type: boolean description: conferidoSemFalta: type: boolean description: tpOcorrenciaRec: description: type: object required: – cdOcorrencia – dsOcorrencia – inEntregue properties: cdOcorrencia: type: integer format: int64 description: dsOcorrencia: type: string description: inEntregue: type: integer format: int64 description: inAnexComprEntrDigit: type: integer format: int64 description: localizacaoVeicRec: description: type: object required: – hrAtualizacao – dsLatitude – dsLongitude properties: hrAtualizacao: type: string format: date-time description: dsLatitude: type: string description: dsLongitude: type: string description: nrPlaca: type: string description: cdSequencia: type: integer format: int64 description: cdVersaoApp: type: integer format: int64 description: cdRoteiro: type: integer format: int64 description: situacaoDispositivo: type: string allOf: – #/definitions/situacaoDispositivoTorreControle description: Status da comunicação com o dispositivo motoristaRec: description: Representa as informações do motorista type: object properties: nrCNPJFilial: type: string description: Filial do Motorista cdMotorista: type: integer format: int64 description: Chave do motorista dsNome: type: string description: Nome do motorista nrCnh: type: string description: CNH do motorista nrCpf: type: string description: CPF do motorista nrRg: type: string description: RG do motorista cdUsuario: type: string description: ID do usuário da plataforma usuarioPlataforma: type: string description: Nome do usuário da plataforma dispositivo: type: string description: Informação do dispositivo simplificada dispositivoRec: type: object allOf: – #/definitions/dispositivoRec description: Informações completas do dispositivo vinculado ao motorista dispositivoRec: description: Representação do dispositivo type: object properties: cdIdentDisp: type: integer format: int64 description: Chave do dispositivo nrTelefone: type: string description: Número do telefone recQuestionarioRespostasAtividade: description: Questionario respondido de determinada atividade type: object required: – cdRoteiro – cdSeqOcorrencia – cdTipoOcorrencia – questionario properties: cdRoteiro: type: integer format: int64 description: Roteiro onde foi realizado a ocorrência cdSeqOcorrencia: type: integer format: int64 description: Código sequencia da ocorrência cdTipoOcorrencia: type: integer format: int64 description: Código do tipo de ocorrência questionario: type: object allOf: – #/definitions/recQuestionarioRespostas description: Questionários e respostas do checklist dadosRecebedorRec: description: Dados do recebedor type: object required: – cdRoteiro – cdSeqOcorrencia – cdTipoOcorrencia – dsImComprovante – imagens – dsAsComprovante – motivoComprovanteInvalido properties: cdRoteiro: type: integer format: int64 description: Roteiro onde foi realizado a ocorrência cdSeqOcorrencia: type: integer format: int64 description: Código sequencia da ocorrência cdTipoOcorrencia: type: integer format: int64 description: Código do tipo de ocorrência dsImComprovante: type: object allOf: – #/definitions/imOcorrenciaRec description: Fotos de comprovantes – Se houver mais de uma apresentar somente a primeira imagens: type: array items: type: object allOf: – #/definitions/imOcorrenciaRec minimum: 1 description: Fotos de comprovantes dsAsComprovante: type: object allOf: – #/definitions/asOcorrenciaRec description: Assinatura da ocorrência motivoComprovanteInvalido: type: string description: Motivo do Comprovante Inválido imOcorrenciaRec: description: Imagem da ocorrência type: object required: – cdSeqImagem – dsArquivo – comprovanteValido properties: cdSeqImagem: type: integer format: int64 description: Código sequencial da imagem dsArquivo: type: string format: byte description: String base64 da imagem urlAcesso: type: string description: Url de acesso a foto da ocorrência comprovanteValido: type: boolean description: Comprovante Válido origem: type: string allOf: – #/definitions/origemComprovante description: Origem do comprovante, se pelo app ou browser asOcorrenciaRec: description: Assinatura da ocorrência type: object required: – dsArquivo properties: dsArquivo: type: string format: byte description: recLatLon: description: type: object required: – lat – lon properties: lat: type: number format: double description: lon: type: number format: double description: MCEREGRec: description: discriminator: _discriminator type: object required: – cdRegiao – _discriminator properties: cdRegiao: type: integer format: int64 description: dsDescricao: type: string description: cdReferencia: type: string description: inStatus: type: integer format: int64 description: dsInStatus: type: string description: inTipo: type: integer format: int64 description: dsInTipo: type: string description: enderecos: type: array items: type: object allOf: – #/definitions/MCEREGEDRec description: poligonos: type: array items: type: object allOf: – #/definitions/PoligonoRec description: filiais: type: array items: type: string description: indicaCidade: type: boolean description: default: false criadoPor: type: string description: Criado por dataCriacao: type: string format: date-time description: Data criação alteradoPor: type: string description: Alterado por dataAlteracao: type: string format: date-time description: Data alteração _discriminator: type: string description: MCETPCARRec: description: discriminator: _discriminator type: object required: – cdTipoCarga – _discriminator properties: cdTipoCarga: type: integer format: int64 description: cdReferencia: type: string description: dsTipoCarga: type: string description: cdEspecie: type: object allOf: – #/definitions/MCEESPCARRec description: incompativeis: type: array items: type: object allOf: – #/definitions/recTipoCarga description: filiais: type: array items: type: string description: inPrioridadeMaxima: type: boolean description: Indica se atividades vinculadas a este tipo de carga devem ser priorizadas durante roteirizações. Exemplo: hortifruti. default: false _discriminator: type: string description: MCEESPCARRec: description: type: object required: – cdEspCarga properties: cdEspCarga: type: integer format: int64 description: dsEspecie: type: string description: dsAbreviacao: type: string description: MCEREGEDRec: description: type: object required: – cdRegiao – cdSequencia – inTipoEnd – dsInTipoEnd properties: cdRegiao: type: integer format: int64 description: cdSequencia: type: integer format: int64 description: inTipoEnd: type: integer format: int64 description: dsInTipoEnd: type: string description: nrFxCEPIni: type: integer format: int64 description: nrFxCEPFin: type: integer format: int64 description: dsLogradouro: type: string description: nrFxNumIni: type: integer format: int64 description: nrFxNumFin: type: integer format: int64 description: dsBairro: type: string description: dsCidade: type: string description: dsEstado: type: string description: dsPais: type: string description: MCEREGPLRec: description: type: object required: – cdRegiao – cdPoligono – dsPoligono – cdSequencia – dsLat – dsLong properties: cdRegiao: type: integer format: int64 description: cdPoligono: type: integer format: int64 description: dsPoligono: type: string description: cdSequencia: type: integer format: int64 description: dsLat: type: string description: dsLong: type: string description: PoligonoRec: description: type: object required: – cdRegiao properties: cdRegiao: type: integer format: int64 description: cdPoligono: type: integer format: int64 description: dsPoligono: type: string description: cdSequencia: type: integer format: int64 description: vertices: type: array items: type: object allOf: – #/definitions/recLatLon description: latitudeMinima: type: number format: double description: latitudeMaxima: type: number format: double description: longitudeMinima: type: number format: double description: longitudeMaxima: type: number format: double description: inTipoRegRec: description: type: object required: – inTipo – dsInTipo properties: inTipo: type: integer format: int64 description: dsInTipo: type: string description: inStatusRegRec: description: type: object required: – inStatus – dsInStatus properties: inStatus: type: integer format: int64 description: dsInStatus: type: string description: inTipoEndRegRec: description: type: object required: – inTipoEnd – dsInTipoEnd properties: inTipoEnd: type: integer format: int64 description: dsInTipoEnd: type: string description: MCEOPERec: description: type: object required: – cdOperacao – dsOperacao properties: cdOperacao: type: integer format: int64 description: cdReferencia: type: string description: dsOperacao: type: string description: filiais: type: array items: type: string description: recRestricaoRegiao: description: type: object required: – cdRegiao – cdRestricao properties: cdRegiao: type: integer format: int64 description: cdRestricao: type: integer format: int64 description: inTpRestricao: type: integer format: int64 description: Tipo de restrição: exigir , restringir recTipoCarga: description: type: object required: – cdTpCarga properties: cdTpCarga: type: integer format: int64 description: cdTpCargaIncomp: type: integer format: int64 description: dsTipoCarga: type: string description: cdRestricao: type: integer format: int64 description: incompativeis: type: array items: type: object allOf: – #/definitions/recTipoCarga description: inTpRestricao: type: integer format: int64 description: Tipo de restrição: exigir , restringir recRestricaoOperacao: description: type: object required: – cdOperacao – cdRestricao properties: cdOperacao: type: integer format: int64 description: cdRestricao: type: integer format: int64 description: cdSequencia: type: integer format: int64 description: inTpRestricao: type: integer format: int64 description: Tipo de restrição: exigir=1 , restringir=0 recRestricao: description: type: object properties: cdRestricao: type: integer format: int64 description: Código da restrição dsRestricao: type: string description: Descrição da restrição inTpRestricao: type: integer format: int64 description: recRestricaoRegiaoDetalhes: description: Registro com detalhes da região e restrição allOf: – #/definitions/MCEREGRec – type: object properties: cdRestricao: type: integer format: int64 description: Código da restrição dsRestricao: type: string description: Descrição da restrição inTpRestricaoAgrupamento: type: integer format: int64 description: Tipo de Restrição do Agrupamento de Veículos horariosRestricao: type: array items: type: object allOf: – #/definitions/recHorariosRestricao description: Horários da restrição da região recRestricaoTipoCargaDetalhes: description: Registro com detalhes do tipo de carga e restrição allOf: – #/definitions/MCETPCARRec – type: object properties: cdRestricao: type: integer format: int64 description: Código da restrição dsRestricao: type: string description: Descrição da restrição inTpRestricao: type: integer format: int64 description: Tipo da restrição recRestricaoOperacaoDetalhes: description: Registro com detalhes da operacao e restrição type: object properties: restricao: type: object allOf: – #/definitions/recRestricao description: Restricao associada a Operacao operacao: type: object allOf: – #/definitions/MCEOPERec description: Operacao associada a Restricao recEntradaSaidaAtv: description: Registro para entrada e saída da atividade type: object required: – cdAtividade properties: cdAtividade: type: integer format: int64 description: Código da atividade cdSequencia: type: integer format: int64 description: Sequência do registro dsUsuario: type: string description: Usuário responsável pelo registro dtHrEntrada: type: string format: date-time description: Data e hora de entrada dtHrSaida: type: string format: date-time description: Data e hora de saída dsLatitudeEntrada: type: string description: Latitude de entrada dsLongitudeEntrada: type: string description: Longitude de entrada dsLatitudeSaida: type: string description: Latitude de saída dsLongitudeSaida: type: string description: Longitude de saída cdVersaoApp: type: integer format: int64 description: Versão instalada do aplicativo móvel utilizada no dispositivo que realizou o envio cdRoteiro: type: integer format: int64 description: Código da Rota em que a Entra e Saída da atividade foi registrada mensagemRec: description: Dados para retorno de mensagens do processamento type: object required: – dsMensagem properties: codigo: type: string description: Código da identificador do objeto relacionado a operação. Ex.: Código Atividade campo: type: string description: Código da identificador de um campo em que ocorreu operação. Ex.: dtPrazoEntrega dsMensagem: type: string description: Descrição da mensagem de sucesso/erro/alerta recDestino: description: Destino type: object properties: cdDestino: type: string description: Código do destino dsDescricao: type: string description: Descrição do destino nrCNPJFilial: type: string description: Filial Destino dsLocal: type: string description: Logradouro destino (cliente) nrCep: type: integer format: int64 description: CEP destino dsLat: type: string description: Latitude geográfica dsLong: type: string description: Longitudade geográfica cdNumero: type: integer format: int64 description: Número do (destino) onde a atividade será realizada dsComplemento: type: string description: Descrição (destino) onde a atividade será realizada dsBairro: type: string description: Bairro (destino) onde a atividade será realizada dsCidade: type: string description: Município (destino) onde a atividade será realizada dsEstado: type: string description: Estado (destino) onde a atividade será realizada dsPais: type: string description: País (destino) onde a atividade será realizada dsLocalOrig: type: string description: Logradouro destino (cliente) Original nrCepOrig: type: integer format: int64 description: CEP destino Original dsLatOrig: type: string description: Latitude geográfica Original dsLongOrig: type: string description: Longitudade geográfica Original cdNumeroOrig: type: integer format: int64 description: Número do (destino) onde a atividade será realizada Original dsBairroOrig: type: string description: Bairro (destino) onde a atividade será realizada Original dsCidadeOrig: type: string description: Município (destino) onde a atividade será realizada Original dsEstadoOrig: type: string description: Estado (destino) onde a atividade será realizada Original dsPaisOrig: type: string description: País (destino) onde a atividade será realizada Original inGrauConf: type: integer format: int64 description: Grau de confiança entre o endereço informado e o geolocalizado recMCEEMPFLREGR: description: Regra de Atendimento de Filial type: object required: – nrCNPJFilial properties: nrCNPJFilial: type: string description: CNPJ da Filial inGrauConf: type: integer format: int64 description: Grau de confiança mínimo para ser considerar atividades como aceitas automaticamente inAnaliseGrauConf: type: integer format: int64 description: Estado no qual a atividade deve ficar caso não atingir o Grau de Confiança mínimo, podendo ser: 0-Recusada ou 1-Em análise qtKmRaio: type: number format: double description: Raio máximo de atendimento de atividades inAnaliseKmRaio: type: integer format: int64 description: Caso raio diferente de zero e atividade mais distante que o configurado, o estado da atividade será: 0-Recusada ou 1-Em análise recFilial: description: type: object properties: cdEmpresa: type: integer format: int64 description: nrCNPJ: type: string description: inTpFilial: type: integer format: int64 description: dsFilial: type: string description: dsEndereco: type: string description: nrCEP: type: integer format: int64 description: nrTelefone: type: string description: dsLatitude: type: string description: dsLongitude: type: string description: inSegundaUtil: type: integer format: int64 description: inTercaUtil: type: integer format: int64 description: inQuartaUtil: type: integer format: int64 description: inQuintaUtil: type: integer format: int64 description: inSextaUtil: type: integer format: int64 description: inSabadoUtil: type: integer format: int64 description: inDomingoUtil: type: integer format: int64 description: coordenada: type: object allOf: – #/definitions/recCoordenada description: Informação de coordenada da empresa recHorariosRestricao: description: Registro referente aos horários e dias de semana da restrição type: object required: – cdRestricao properties: cdRegiao: type: integer format: int64 description: Código da região cdRestricao: type: integer format: int64 description: Código da restrição cdSequencia: type: integer format: int64 description: Código sequencial da faixa de horário inDiaSemana: type: integer format: int64 description: Dia da semana correspondente, começando a partir do Zero (Domingo) hrInicial: type: string format: date-time description: Hora inicial hrFinal: type: string format: date-time description: Hora final listaAtividadesNivelDeServicoRec: description: Dados da atividade para o Painel Analytics (grid realizados, não realizados, no prazo, em atraso) type: object required: – cdRegistro – dsDescricao – atividadeStatus – quantidadeAtividadeStatus – tipoGrid – qtdRealizadas – qtdNaoRealizadas – qtdFinalSemApont – qtdNoPrazo – qtdEmAtraso properties: cdRegistro: type: string description: código do registro: cdDestino, nrPlaca, cdGrupoVeiculo, cdMotorista. dependendo do filtro usado dsDescricao: type: string description: atividadeStatus: type: string description: quantidadeAtividadeStatus: type: integer format: int64 description: tipoGrid: type: string description: qtdRealizadas: type: integer format: int64 description: Quantidade de atividades realizadas qtdNaoRealizadas: type: integer format: int64 description: Quantidade de atividades não realizadas qtdFinalSemApont: type: integer format: int64 description: Quantidade de atividades finalizadas em apontamento qtdNoPrazo: type: integer format: int64 description: Quantidade de atividades no prazo qtdEmAtraso: type: integer format: int64 description: Quantidade de atividades em atraso listaStatusEContadorStatusRec: description: Dados das atividades para os gráficos do Painel Analytics type: object required: – ativitdadesStatus – quantidadeAtividadeStatus properties: ativitdadesStatus: type: string description: quantidadeAtividadeStatus: type: integer format: int64 description: totaisAlocacaoProdutividadeRec: description: Dados da atividade para o Painel Analytics (grid realizados, não realizados, no prazo, em atraso) type: object required: – totalAtividades – totalAtividadesRealizadasNoPrazo – totalRotas – totalKm – totalPeso – totalCapacidadePeso – totalM3 – totalTempo – totalOcupacaoGeral – totalEficiencia – listaResultadoDetalhes properties: totalAtividades: type: integer format: int64 description: totalAtividadesRealizadasNoPrazo: type: integer format: int64 description: totalRotas: type: integer format: int64 description: totalKm: type: number format: double description: totalPeso: type: number format: double description: totalCapacidadePeso: type: number format: double description: totalM3: type: number format: double description: totalTempo: type: number format: double description: totalOcupacaoGeral: type: number format: double description: totalEficiencia: type: number format: double description: listaResultadoDetalhes: type: array items: type: object allOf: – #/definitions/detalhesAlocacaoProdutividadeRec minimum: 1 description: Lista de detalhes detalhesAlocacaoProdutividadeRec: description: Detalhes da atividade para a grid do Painel Analytics type: object required: – codigoReferencia – veiculo – rota – atividade – quilometragem – peso – capacidadePeso – metragemCubica – horas – ocupacaoGeral – atividadesRealizadas – atividadesNaoRealizadas – eficiencia properties: codigoReferencia: type: string description: veiculo: type: string description: rota: type: integer format: int64 description: atividade: type: integer format: int64 description: quilometragem: type: number format: double description: peso: type: number format: double description: capacidadePeso: type: number format: double description: metragemCubica: type: number format: double description: horas: type: number format: double description: ocupacaoGeral: type: number format: double description: atividadesRealizadas: type: integer format: int64 description: atividadesNaoRealizadas: type: integer format: int64 description: eficiencia: type: number format: double description: recDiasUteisDestino: description: Informação de dias úteis do destino type: object required: – cdDestino – dsDiaSemana – hrInicial – hrFinal properties: cdDestino: type: string description: Código identificador do destino dsDiaSemana: type: string description: Descrição do dia da semana. Ex: Segunda-Feira, Terça-Feira e etc hrInicial: type: string format: date-time description: Hora inicial de atendimento do destino hrFinal: type: string format: date-time description: Hora final de atendimento do destino recRestricoesDiasUteisDestino: description: type: object required: – diasUteisDestino – restricoesDestino properties: diasUteisDestino: type: array items: type: object allOf: – #/definitions/recDiasUteisDestino minimum: 1 description: restricoesDestino: type: array items: type: object allOf: – #/definitions/recRestricoesDestino minimum: 1 description: recRestricoesDestino: description: Informação de dias úteis do destino type: object required: – cdDestino – cdRestricao – dsRestricao – nrPlaca – nrFinalPlaca properties: cdDestino: type: string description: Código identificador do destino cdRestricao: type: integer format: int64 description: Código identificador da restrição dsRestricao: type: string description: Descrição da restrição nrPlaca: type: string description: Placa do veículo nrFinalPlaca: type: string description: Final de Placa recRestricoesRegiaoOperacaoTipoCarga: description: Agruga record para restrições de região, opeação e tipo de carga type: object required: – regioesAtividade – veiculosNaoAtendeOperacaoAtv – veiculosNaoAtendeTipoCargaAtv – tiposDeCargaIncompAtv properties: regioesAtividade: type: array items: type: object allOf: – #/definitions/recRegioesAtividade minimum: 1 description: Informações básicas da região veiculosNaoAtendeOperacaoAtv: type: array items: type: object allOf: – #/definitions/recVeiculos minimum: 1 description: Veículos que não podem atender a operação da atividade veiculosNaoAtendeTipoCargaAtv: type: array items: type: object allOf: – #/definitions/recVeiculos minimum: 1 description: veículos que não podem atender ao tipo de carga da atividade tiposDeCargaIncompAtv: type: array items: type: object allOf: – #/definitions/MCETPCARRec minimum: 1 description: tipos de carga incompatíveis com o tipo de carga da atividade recRegioesAtividade: description: Informações básicas da região type: object required: – cdAtividade – cdRegiao – dsDescricaoRegiao – arVeiculos properties: cdAtividade: type: integer format: int64 description: Código identificador da atividade cdRegiao: type: integer format: int64 description: Código identificador da região dsDescricaoRegiao: type: string description: Descrição da região arVeiculos: type: array items: type: object allOf: – #/definitions/recVeiculos minimum: 1 description: lista de veículos recVeiculos: description: Informações básicas do veículo type: object required: – cdGrupoveiculo – nrPlaca – dsVeiculo – nrCnpjFilial – inSituacao properties: cdGrupoveiculo: type: integer format: int64 description: Código identificador do grupo do veículo nrPlaca: type: string description: Código identificador do veículo dsVeiculo: type: string description: Descrição do veículo nrCnpjFilial: type: string description: Cnpj da filial do veículo inSituacao: type: integer format: int64 description: Situação do veículo TotaisAtividades: description: type: object required: – totalAtividadesEmAnalise properties: totalAtividadesEmAnalise: type: integer format: int64 description: recEstradaSaida: description: Data e Hora de Entrada e Saída type: object properties: dtHrEntrada: type: string format: date-time description: Data e hora de entrada dtHrSaida: type: string format: date-time description: Data e hora de saída recEstradaSaidaRotaAtv: description: Agrupa estrada e saida da rota e da atividade type: object properties: entradaSaidaRota: type: array items: type: object allOf: – #/definitions/recEstradaSaida description: Data e hora de entrada e saída das atividades da rota entradaSaidaAtividade: type: array items: type: object allOf: – #/definitions/recEstradaSaida description: Data e hora de entrada e saída da atividade configuracaoRec: description: type: object required: – dsUrlServidor properties: dsUrlServidor: type: string description: importacaoRec: description: type: object properties: cdImportacao: type: integer format: int64 description: dsImportacao: type: string description: inImportacao: type: integer format: int64 description: dsEntrada: type: string description: dtInicio: type: string format: date-time description: dtFim: type: string format: date-time description: dsUsuario: type: string description: dsRefRoteiros: type: string description: importacaoComLogRec: description: type: object required: – importacao – logs properties: importacao: type: object allOf: – #/definitions/importacaoRec description: logs: type: array items: type: object allOf: – #/definitions/importacaoLogRec minimum: 1 description: importacaoLogRec: description: type: object required: – cdLog – cdImportacao – dsErro – dsItens – dtLog properties: cdLog: type: integer format: int64 description: cdImportacao: type: integer format: int64 description: dsErro: type: string description: dsItens: type: string description: dtLog: type: string format: date-time description: MCEEMBrec: description: cadastro de embarcadores type: object required: – cdEmbarcador – dsEmbarcador – filiais – nrCPFCNPJEmbarcador properties: cdEmbarcador: type: string description: código do embarcador dsEmbarcador: type: string description: descrição do embarcador filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: lista de filiais que o embarcador está vinculado nrCPFCNPJEmbarcador: type: string description: cnpj do embarcador ocorrencias: type: array items: type: integer format: int64 description: Códigos dos Tipos de Ocorrência MCEEMBFLrec: description: type: object required: – cdEmbarcador – nrCnpfFilial properties: cdEmbarcador: type: string description: código do embarcador nrCnpfFilial: type: string description: atualizaTemposOcorrenciaRec: description: type: object required: – cdAtividade – cdSequencia – cdOcorrencia – cdRoteiro – dtPosIni – dtMovimento properties: cdAtividade: type: integer format: int64 description: cdSequencia: type: integer format: int64 description: cdOcorrencia: type: integer format: int64 description: cdRoteiro: type: integer format: int64 description: dtPosIni: type: string format: date-time description: dtMovimento: type: string format: date-time description: inicializacaoRec: description: type: object required: – cdInicializacao – dsFuncao – inRepetirExecucao – dtUltimaExecucao properties: cdInicializacao: type: integer format: int64 description: dsFuncao: type: string description: inRepetirExecucao: type: boolean description: dtUltimaExecucao: type: string format: date-time description: dadosAcessoArquivo: description: Define os dados de acesso ao arquivo salvo no serviço de atividades type: object required: – ok – msgErro – idBlobServiceFile – fileName – urlAcesso – dtArquivoDisponivelAte properties: ok: type: boolean description: Indica o status do retorno msgErro: type: string description: Mensagem de erro quando houver idBlobServiceFile: type: string description: Id do Arquivo no serviço de arquivos fileName: type: string description: Nome do arquivo urlAcesso: type: string description: Url para realizar o download dtArquivoDisponivelAte: type: string format: date-time description: Data limite para acessar realizar o download 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 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 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 pontoApoioRec: description: Objeto do ponto de apoio type: object properties: idPontoApoio: type: integer format: int64 description: Código identificador do ponto de apoio latitude: type: number format: double description: Latitude longitude: type: number format: double description: Longitude recPontoApoio: description: Objeto do ponto de apoio type: object required: – localizacao properties: localizacao: type: object allOf: – #/definitions/recCoordenada description: Informação localização roteiroManual: description: Registro que compõe a rota que será gerada na roteirização manual, via integração de atividades type: object required: – nrCNPJFilial – nrPlaca properties: nrCNPJFilial: type: string description: CNPJ da filial correspondente nrPlaca: type: string description: Placa do veículo correspondente nrPlaca2: type: string description: Segunda placa correspondente nrCpfMotorista: type: string description: CPF do motorista correspondente dsReferencia: type: string description: Referência aplicada a rota dtInicio: type: string format: date-time description: Data de início da rota atividades: type: array items: type: object allOf: – #/definitions/MCEATVRec description: Atividades que comporão a rota retornaParaOrigem: type: boolean description: Indica se o veículo vai retornar para a filial de origem após realizar a última atividade. Caso não informado será buscado das definições da filial. Valores: TRUE-volta para a filial de origem; FALSE-termina a rota na última atividade, não calculando tempo/quilometragem de retorno veiculoRoteiroManual: description: Veículo utilizado no processo de roteirização manual via integração type: object required: – nrPlaca – filial properties: cdGrupoVeiculo: type: integer format: int64 description: Código Grupo do veículo cdGrupoVeiculoNrPlaca2: type: integer format: int64 description: Código Grupo do veículo referente a segunda placa nrCNPJFilial: type: string description: CNPJ da Filial do veículo nrPlaca: type: string description: Placa nrPlaca2: type: string description: Segunda placa dsRegiaoAtend: type: string description: Descrição da região de atendimento motorista: type: object allOf: – #/definitions/motoristaVeiculo description: Motorista do veículo filial: type: object allOf: – #/definitions/recFilial description: Filial do veículo motoristaVeiculo: description: Motorista do veículo type: object required: – cdMotorista – dsNome – nrCpf properties: cdMotorista: type: integer format: int64 description: Código do motorista dsNome: type: string description: Nome do motorista nrCpf: type: string description: CPF do motorista recInformacaoVisaoGeralTorre: description: Informação Visão Geral Torre Controle type: object required: – totalAtividades – totalAtividadesPendentes – totalAtividadesConcluidas properties: totalAtividades: type: integer format: int64 description: Total de atividades minimum: 0 totalAtividadesPendentes: type: integer format: int64 description: Total de atividades pendentes minimum: 0 totalAtividadesConcluidas: type: integer format: int64 description: Total de atividades concluídas minimum: 0 recAtividadesPendentes: description: Informações gerais das atividades pendentes na Torre type: object required: – percentualAtividadesPendentesNoPrazo – atividadesPendentesPrazo – atividadesPendentesEmAlerta – atividadesPendentesEmAtraso properties: percentualAtividadesPendentesNoPrazo: type: integer format: int64 description: Percentual de atividades pendentes no prazo minimum: 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: – percentualAtividadesConcluidasNoPrazo – atividadesConcluidasNoPrazo – atividadesConcluidasComAtraso – atividadesConcluidasNaoRealizadas properties: percentualAtividadesConcluidasNoPrazo: type: integer format: int64 description: Percentual de atividades concluidas no prazo minimum: 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 minimum: 0 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 filial: type: object allOf: – #/definitions/filialRec 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 filialRec: 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/filialRec 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 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 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/tipoAtividadeRec description: Tipo da Atividade [coleta – entrega – serviço] filial: type: object allOf: – #/definitions/filialRec description: Informação da Filial destino: type: object allOf: – #/definitions/destinoRec 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 tipoAtividadeRec: 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 destinoRec: 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: number format: double description: Quantidade hodometro: type: integer format: int64 description: Hodometro coordenada: type: object allOf: – #/definitions/recCoordenada description: Coordenada 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 totalizadorMCEATVSemRegiao: description: Informação Gerais de Atividades sem Região agrupadas por filiais type: object required: – nrCnpjFilial properties: nrCnpjFilial: type: string description: CNPJ da Filial total: type: integer format: int64 description: Total de Atividades sem Regiao default: 0 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 recDevice: description: Dispositivo type: object required: – id properties: id: type: string description: Identificação do dispositivo 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 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 recAtividadeSemRegiao: description: Informações sobre atividades sem região type: object properties: nrCNPJFilial: type: string description: Número do CNPJ da Filial dsNrDocto: type: string description: Número do documento cdAtividade: type: integer format: int64 description: Código da atividade inAtividade: type: integer format: int64 description: Tipo de atividade dsInAtividade: type: string description: Descrição do tipo de atividade dsDestinatario: type: string description: Descrição destinatário dsLocal: type: string description: Descrição do local cdNumero: type: integer format: int64 description: Número do local dsBairro: type: string description: Bairro dsCidade: type: string description: Cidade dsEstado: type: string description: Estado dsPais: type: string description: País nrCep: type: integer format: int64 description: CEP dsLat: type: string description: Latitude dsLong: type: string description: Longitude recPergunta: description: Pergunta do checklist type: object required: – ativo properties: id: type: string description: UUID referencia: type: string description: Campo referência para controle de perguntas por parte do usuário descricao: type: string description: Descrição da pergunta obrigatorio: type: boolean description: Obrigatorio responder a pergunta tipoResposta: type: string allOf: – #/definitions/enumTipoResposta description: Tipo de resposta tamanhoMinimo: type: integer format: int64 description: Tamanho mínimo da pergunta tamanhoMaximo: type: integer format: int64 description: Tamanho máximo da pergunta ativo: type: boolean description: Ativo recPerguntaResposta: description: Pergunta e respectiva resposta do checklist type: object required: – descricao – tipoResposta properties: id: type: string description: UUID da pergunta descricao: type: string description: Descrição da pergunta tipoResposta: type: string allOf: – #/definitions/enumTipoResposta description: Tipo de resposta resposta: type: string description: Resposta recQuestionarioAtividade: description: Vínculo entre a ocorrência utilizada no apontamento e o questionário a ser apresentado type: object required: – cdAtividade – dsNrDocto – ocorrencias properties: cdAtividade: type: integer format: int64 description: dsNrDocto: type: string description: ocorrencias: type: array items: type: object allOf: – #/definitions/recRegraOcorrenciaQuestionario minimum: 1 description: recRegraOcorrenciaQuestionario: description: Regra para apresentar determinado questionário type: object required: – ocorrencia – questionario properties: ocorrencia: type: integer format: int64 description: Ocorrência que deve apresentar o questionário questionario: type: integer format: int64 description: Código do questionário recRegraQuestionario: description: Regra de questionario type: object required: – codigo – descricao – codigoOcorrencia – descricaoOcorrencia – codigoTipoCarga – descricaoTipoCarga – codigoEspecieCarga – descricaoEspecieCarga – codigoQuestionario – descricaoQuestionario – ativo properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição codigoOcorrencia: type: integer format: int64 description: Código da Ocorrencia descricaoOcorrencia: type: string description: Descrição da Ocorrencia codigoTipoCarga: type: integer format: int64 description: código do Tipo de carga descricaoTipoCarga: type: string description: Descrição do Tipo de carga codigoEspecieCarga: type: integer format: int64 description: código da Espécie de carga descricaoEspecieCarga: type: string description: Descrição da Espécie de carga codigoQuestionario: type: integer format: int64 description: Questionario descricaoQuestionario: type: string description: Questionario ativo: type: boolean description: Ativo? recQuestionario: description: Questionario type: object required: – codigo – descricao – ativo properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição ativo: type: boolean description: Ativo? recQuestionarioCompleto: description: Questionário com lista de perguntas type: object required: – codigo – descricao – perguntas properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição perguntas: type: array items: type: object allOf: – #/definitions/recPergunta minimum: 1 description: Lista de Perguntas recQuestionarioRespostas: description: Questionário com lista de perguntas e respectivas respostas type: object required: – codigo – descricao – perguntasRespostas properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição perguntasRespostas: type: array items: type: object allOf: – #/definitions/recPerguntaResposta minimum: 1 description: Lista de Perguntas e respostas recRegiaoDescricao: description: type: object required: – cdRegiao – dsDescricao properties: cdRegiao: type: integer format: int64 description: dsDescricao: type: string description: atividadesPainelRec: description: type: object required: – atividade – tipo – filial – nrDocumento – origemDestino – rota – situacaoRota – placa – motorista – foto – prazoAtendimento – status – endereco – dataAgendamento – apelidoOcorrencia – dataUltimaOcorrencia properties: atividade: type: integer format: int64 description: Código da atividade tipo: type: object allOf: – #/definitions/tipoAtividadeRec description: Tipo (Entrega / Coleta ou Serviço) filial: type: string description: Filial nrDocumento: type: string description: Documento origemDestino: type: string description: Origem/Destino rota: type: integer format: int64 description: Rota situacaoRota: type: string allOf: – #/definitions/enumSituacaoRota description: Situação da rota placa: type: string description: Placa motorista: type: string description: Motorista foto: type: boolean description: Foto (Sim ou Não) prazoAtendimento: type: string format: date-time description: Prazo de Atendimento status: type: string allOf: – #/definitions/situacaoAtividade description: Status endereco: type: string description: Endereço do local onde será feita a entrega ou coleta dataAgendamento: type: string format: date-time description: Data de Agendamento apelidoOcorrencia: type: string description: Apelido da última ocorrência da atividade dataUltimaOcorrencia: type: string format: date-time description: Data da Ocorrência 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 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ê?

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