tmsentregas

empresas

81 views 07/11/2018 04/11/2019 integrador 0

2.0info: 1.17.4 empresas description: Serviço para cadastramento de empresas e filiais x-senior-domain: tmsentregas x-senior-domain-path: tmsentregas x-senior-service-path: empresas contact: name: Senior X Platform url: http://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: /empresas/queries/buscaEmpresas: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdEmpresaIni: type: integer format: int64 description: cdEmpresaFim: type: integer format: int64 description: dsEmpresa: type: string description: responses: 200: description: Ok schema: type: object required: – dsErro – listaResultado properties: dsErro: type: string description: listaResultado: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdEmpresaIni description: in: query type: integer format: int64 – name: cdEmpresaFim description: in: query type: integer format: int64 – name: dsEmpresa description: in: query type: string responses: 200: description: Ok schema: type: object required: – dsErro – listaResultado properties: dsErro: type: string description: listaResultado: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaFiliais: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdEmpresa: type: integer format: int64 description: Código da filial nrCNPJ: type: string description: CNPJ da filial dsFilial: type: string description: Descrição da filial filiais: type: array items: type: string description: Lista com o CNPJ de filiais carregaDepDefinicoes: type: boolean description: Se verdadeiro retorna os dados das definições da filial. Padrão: falso responses: 200: description: Ok schema: type: object required: – dsErro – listaResultado properties: dsErro: type: string description: listaResultado: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdEmpresa description: Código da filial in: query type: integer format: int64 – name: nrCNPJ description: CNPJ da filial in: query type: string – name: dsFilial description: Descrição da filial in: query type: string – name: filiais description: Lista com o CNPJ de filiais in: query type: array items: type: string – name: carregaDepDefinicoes description: Se verdadeiro retorna os dados das definições da filial. Padrão: falso in: query type: boolean responses: 200: description: Ok schema: type: object required: – dsErro – listaResultado properties: dsErro: type: string description: listaResultado: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaTodasFiliais: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: carregaDepDefinicoes: type: boolean description: Se verdadeiro retorna os dados das definições da filial. Padrão: falso responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: carregaDepDefinicoes description: Se verdadeiro retorna os dados das definições da filial. Padrão: falso in: query type: boolean responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaFiliaisFiltrosPapel: post: description: Pesquisa de filiais utilizada na tela de Gestão dos Papéis, aba Filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro parameters: type: array items: type: object allOf: – #/definitions/keyValue description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/simpleData minimum: 1 description: Lista com resultados da pesquisa default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaDefinicoes: post: description: Pesquisa de Definições e Restrições tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial properties: nrCNPJFilial: type: string description: CNPJ identificador (filial). responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/MCEDEFRec minimum: 1 description: Resultado da operação default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Definições e Restrições tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: CNPJ identificador (filial). in: query required: true type: string responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/MCEDEFRec minimum: 1 description: Resultado da operação default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaRegrasAtend: post: description: Pesquisa de Regras de Atendimento da Filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial properties: nrCNPJFilial: type: string description: Lista de CNPJ (filial), seperadas por vírgula responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/recMCEEMPFLREGR minimum: 1 description: Resultado da operação default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Regras de Atendimento da Filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: Lista de CNPJ (filial), seperadas por vírgula in: query required: true type: string responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/recMCEEMPFLREGR minimum: 1 description: Resultado da operação default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaOperadorasPedagio: post: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/OperadoraPedagioRec minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/OperadoraPedagioRec minimum: 1 description: default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaOperadoraPedagioPorFilial: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCnpjFilial properties: nrCnpjFilial: type: string description: responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: object allOf: – #/definitions/DefinicaoOperadoraPedagioRec description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCnpjFilial description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: object allOf: – #/definitions/DefinicaoOperadoraPedagioRec description: default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaCertificadoDigitalPorFilial: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial properties: nrCNPJFilial: type: string description: responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: object allOf: – #/definitions/CertificadoDigitalRec description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: object allOf: – #/definitions/CertificadoDigitalRec description: default: description: Error response schema: #/definitions/genericError /empresas/queries/certificaDestinos: post: description: Certifica Destinos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – destinos properties: destinos: type: array items: type: object allOf: – #/definitions/recDestino minimum: 1 description: Destinos 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, caso ocorra listaNOK: type: array items: type: object allOf: – #/definitions/recDestino minimum: 1 description: Destinos que não obtiveram êxito na operação. listaOk: type: array items: type: object allOf: – #/definitions/recDestino minimum: 1 description: Destinos que obtiveram êxito na operação. default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaDestinos: post: description: Pesquisa de Destinos 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 destinos: type: array items: type: string description: Lista de Códigos identificador de destino. dsDescricao: type: string description: Descrição do destino nrCNPJFilial: type: string description: Filial Destino filiais: type: array items: type: string description: Lista com o CNPJ de filiais dsLocal: type: string description: Logradouro destino (cliente) nrCep: type: integer format: int64 description: 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 listaInGrauConf: type: array items: type: integer format: int64 description: Grau de Confiança: 0 – Nulo, 1 – Baixo, 2 – Médio, 3 – Alto, 4 – Manual. Ao informar a latitude e longitude no endereço, a confiança classificada automaticamente como Manual. inConsGrauMinimo: type: boolean description: Consiste o grau mínimo da filial 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: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/recDestino minimum: 1 description: Resultado da operação totalItens: type: integer format: int64 description: Total de itens para a paginação default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Destinos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdDestino description: Código do destino in: query type: string – name: destinos description: Lista de Códigos identificador de destino. in: query type: array items: type: string – name: dsDescricao description: Descrição do destino in: query type: string – name: nrCNPJFilial description: Filial Destino in: query type: string – name: filiais description: Lista com o CNPJ de filiais in: query type: array items: type: string – name: dsLocal description: Logradouro destino (cliente) in: query type: string – name: nrCep description: in: query type: integer format: int64 – name: cdNumero description: Número do (destino) onde a atividade será realizada in: query type: integer format: int64 – name: dsComplemento description: Descrição (destino) onde a atividade será realizada in: query type: string – name: dsBairro description: Bairro (destino) onde a atividade será realizada in: query type: string – name: dsCidade description: Munic�pio (destino) onde a atividade será realizada in: query type: string – name: dsEstado description: Estado (destino) onde a atividade será realizada in: query type: string – name: dsPais description: País (destino) onde a atividade será realizada in: query type: string – name: listaInGrauConf description: Grau de Confiança: 0 – Nulo, 1 – Baixo, 2 – Médio, 3 – Alto, 4 – Manual. Ao informar a latitude e longitude no endereço, a confiança classificada automaticamente como Manual. in: query type: array items: type: integer format: int64 – name: inConsGrauMinimo description: Consiste o grau mínimo da filial in: query type: boolean – 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: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/recDestino minimum: 1 description: Resultado da operação totalItens: type: integer format: int64 description: Total de itens para a paginação default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaHistoricosEnderecos: post: description: Pequisa de Histórico de endereços 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 destinos: type: array items: type: string description: Lista de Códigos identificador de destino. 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: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/recHistoricoEndereco minimum: 1 description: Resultado da operação totalItens: type: integer format: int64 description: Total de itens para a paginação default: description: Error response schema: #/definitions/genericError get: description: Pequisa de Histórico de endereços tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdDestino description: Código do destino in: query type: string – name: destinos description: Lista de Códigos identificador de destino. in: query type: array items: 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: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro, caso ocorra listaResultado: type: array items: type: object allOf: – #/definitions/recHistoricoEndereco minimum: 1 description: Resultado da operação totalItens: type: integer format: int64 description: Total de itens para a paginação default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaTotaisDestinosParaGeocodificar: post: description: Pesquisa de Destinos 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 responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro, caso ocorra resultado: type: object allOf: – #/definitions/totaisDestinosParaGeocodificar description: Resultado da operação default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Destinos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filiais description: Lista com o CNPJ de filiais in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro, caso ocorra resultado: type: object allOf: – #/definitions/totaisDestinosParaGeocodificar description: Resultado da operação default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaHorariosDestinos: post: description: Busca de horários do destino tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdDestino: type: string description: Destino cdHorario: type: integer format: int64 description: horários destinos: type: array items: type: string description: Lista de Códigos de destinos a serem retornados responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro ocorrido. listaResultado: type: array items: type: object allOf: – #/definitions/recHorarioDestino minimum: 1 description: Resultado da pesquisa default: description: Error response schema: #/definitions/genericError get: description: Busca de horários do destino tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdDestino description: Destino in: query type: string – name: cdHorario description: horários in: query type: integer format: int64 – name: destinos description: Lista de Códigos de destinos a serem retornados in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro ocorrido. listaResultado: type: array items: type: object allOf: – #/definitions/recHorarioDestino minimum: 1 description: Resultado da pesquisa default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaRestricoesDestinos: post: description: Busca de horários do destino tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdDestino: type: string description: Destino cdRestricao: type: integer format: int64 description: restrição destinos: type: array items: type: string description: Lista de Códigos de destinos a serem localizados responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro ocorrido. listaResultado: type: array items: type: object allOf: – #/definitions/recRestricaoDestino minimum: 1 description: Resultado da pesquisa default: description: Error response schema: #/definitions/genericError get: description: Busca de horários do destino tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdDestino description: Destino in: query type: string – name: cdRestricao description: restrição in: query type: integer format: int64 – name: destinos description: Lista de Códigos de destinos a serem localizados in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro ocorrido. listaResultado: type: array items: type: object allOf: – #/definitions/recRestricaoDestino minimum: 1 description: Resultado da pesquisa default: description: Error response schema: #/definitions/genericError /empresas/queries/permiteRoteirizar: post: description: Verifica se o cliente possui Roteirizaçã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: – ok – dsErro – inPermissao properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Resultado de erro inPermissao: type: integer format: int64 description: Retorna o tipo de permissão do roteirizador default: description: Error response schema: #/definitions/genericError get: description: Verifica se o cliente possui Roteirização tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – ok – dsErro – inPermissao properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Resultado de erro inPermissao: type: integer format: int64 description: Retorna o tipo de permissão do roteirizador default: description: Error response schema: #/definitions/genericError /empresas/queries/permiteMonitorar: post: description: Verifica se o cliente possui Monitoramento 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 – possuiPermissao properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Resultado de erro possuiPermissao: type: boolean description: Retorna se cliente possui ou não permissão default: description: Error response schema: #/definitions/genericError get: description: Verifica se o cliente possui Monitoramento tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – ok – dsErro – possuiPermissao properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Resultado de erro possuiPermissao: type: boolean description: Retorna se cliente possui ou não permissão default: description: Error response schema: #/definitions/genericError /empresas/queries/grauConfiancaEnd: post: description: Consiste e retorna o grau de confiança do endereço certificado com relação ao original (informado) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entrada properties: entrada: type: object allOf: – #/definitions/recGrauConfiancaIn description: Informar dados de entrada e saída do geolocalizador responses: 200: description: Ok schema: type: object required: – saida – ok – dsErro properties: saida: type: object allOf: – #/definitions/recGrauConfiancaOut description: Código do grau de confiança e Descrição ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /empresas/queries/recalculaGrauConfiancaEnd: post: description: Recalcula e retorna o grau de confiança do endereço certificado com relação ao original (informado) 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: Lista com as filiais para o recalculo do grau de confiança alterarDestinosRecalculados: type: boolean description: Alterar os destinos (Passar true para alterar o destino com o grau de confiança recalculado) responses: 200: description: Ok schema: type: object required: – saida – ok – dsErro properties: saida: type: array items: type: object allOf: – #/definitions/recRecalculaGrauConfianca minimum: 1 description: Código do grau de confiança e Descrição ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Recalcula e retorna o grau de confiança do endereço certificado com relação ao original (informado) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filiais description: Lista com as filiais para o recalculo do grau de confiança in: query required: true type: array items: type: string minimum: 1 – name: alterarDestinosRecalculados description: Alterar os destinos (Passar true para alterar o destino com o grau de confiança recalculado) in: query type: boolean responses: 200: description: Ok schema: type: object required: – saida – ok – dsErro properties: saida: type: array items: type: object allOf: – #/definitions/recRecalculaGrauConfianca minimum: 1 description: Código do grau de confiança e Descrição ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /empresas/queries/obterProximaDataUtilFilial: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCnpjFilial properties: nrCnpjFilial: type: string description: responses: 200: description: Ok schema: type: object required: – proximoDiaUtilFilial properties: proximoDiaUtilFilial: type: string format: date-time description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCnpjFilial description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – proximoDiaUtilFilial properties: proximoDiaUtilFilial: type: string format: date-time description: default: description: Error response schema: #/definitions/genericError /empresas/queries/buscaMatrizPorFilial: post: description: Retorna a matriz de uma empresa a partir do CNPJ de qualquer de suas filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCnpjFilial properties: nrCnpjFilial: type: string description: 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/recFilial description: default: description: Error response schema: #/definitions/genericError get: description: Retorna a matriz de uma empresa a partir do CNPJ de qualquer de suas filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCnpjFilial description: in: query required: true type: string 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/recFilial description: default: description: Error response schema: #/definitions/genericError /empresas/queries/buscarFiliaisPapel: post: description: Busca as filiais conforme o papel informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: Papel para consulta responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Se a consulta foi executada sem erros dsErro: type: string description: Possíveis mensagens de erro listaResultado: type: array items: type: object allOf: – #/definitions/recMCEPAPFL minimum: 1 description: Lista com o resultado da consulta default: description: Error response schema: #/definitions/genericError get: description: Busca as filiais conforme o papel informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idPapel description: Papel para consulta in: query required: true type: string responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Se a consulta foi executada sem erros dsErro: type: string description: Possíveis mensagens de erro listaResultado: type: array items: type: object allOf: – #/definitions/recMCEPAPFL minimum: 1 description: Lista com o resultado da consulta default: description: Error response schema: #/definitions/genericError /empresas/queries/buscarPermissaoPapel: post: description: Busca as permissões definidas aos papeis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: idPapel: type: string description: Papel para consulta idUsuario: type: string description: Usuário para consulta responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Se a consulta foi executada sem erros dsErro: type: string description: Possíveis mensagens de erro resultado: type: object allOf: – #/definitions/recMCEPAPPE description: Permissões conforme pesquisa default: description: Error response schema: #/definitions/genericError get: description: Busca as permissões definidas aos papeis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idPapel description: Papel para consulta in: query type: string – name: idUsuario description: Usuário para consulta in: query type: string responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Se a consulta foi executada sem erros dsErro: type: string description: Possíveis mensagens de erro resultado: type: object allOf: – #/definitions/recMCEPAPPE description: Permissões conforme pesquisa default: description: Error response schema: #/definitions/genericError /empresas/queries/buscarPermissaoPapelUsuarioLogado: post: description: Busca as permissões do conforme papel do usuário logado 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 – resultado properties: ok: type: boolean description: Se executou com sucesso dsErro: type: string description: Possíveis mensagens de erro resultado: type: object allOf: – #/definitions/recMCEPAPPE description: Resultado da consulta default: description: Error response schema: #/definitions/genericError get: description: Busca as permissões do conforme papel do usuário logado tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – ok – dsErro – resultado properties: ok: type: boolean description: Se executou com sucesso dsErro: type: string description: Possíveis mensagens de erro resultado: type: object allOf: – #/definitions/recMCEPAPPE description: Resultado da consulta default: description: Error response schema: #/definitions/genericError /empresas/queries/buscarFiliaisUsuario: post: description: Busca as filiais conforme usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idUsuario properties: idUsuario: type: string description: Usuário para consulta carregaDepDefinicoes: type: boolean description: Se irá retornar as infomrações das definições das filiais responses: 200: description: Ok schema: type: object required: – ok – dsErro – filiais properties: ok: type: boolean description: Se executou com sucesso dsErro: type: string description: Possíveis mensagens de erro filiais: type: array items: type: object allOf: – #/definitions/recFilialCompl minimum: 1 description: Resultado da consulta default: description: Error response schema: #/definitions/genericError get: description: Busca as filiais conforme usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idUsuario description: Usuário para consulta in: query required: true type: string – name: carregaDepDefinicoes description: Se irá retornar as infomrações das definições das filiais in: query type: boolean responses: 200: description: Ok schema: type: object required: – ok – dsErro – filiais properties: ok: type: boolean description: Se executou com sucesso dsErro: type: string description: Possíveis mensagens de erro filiais: type: array items: type: object allOf: – #/definitions/recFilialCompl minimum: 1 description: Resultado da consulta default: description: Error response schema: #/definitions/genericError /empresas/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: 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: default: description: Error response schema: #/definitions/genericError /empresas/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /empresas/actions/inicializaRegrasAtendPadrao: post: description: Utilizado pelo frontend para cadastrar regras de atendimento padr�o para filiais que ainda não possuem 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 default: description: Error response schema: #/definitions/genericError /empresas/actions/insereEmpresa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: object allOf: – #/definitions/recEmpresa description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – cdEmpresa properties: ok: type: boolean description: dsErro: type: string description: cdEmpresa: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /empresas/actions/alteraEmpresa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: object allOf: – #/definitions/recEmpresa description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /empresas/actions/deletaEmpresa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdEmpresa properties: cdEmpresa: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /empresas/actions/insereFilial: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filial properties: filial: type: object allOf: – #/definitions/recFilial description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /empresas/actions/alteraFilial: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filial properties: filial: type: object allOf: – #/definitions/recFilial description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /empresas/actions/deletaFilial: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJ properties: nrCNPJ: type: string description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /empresas/actions/insereDefinicoes: post: description: Cadastro de Definições e restrições tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial – qtTempoAtendPad – qtTempoAlertaAtraso – qtTempoAltRotExec – qtTempoAltRotFin – inConsQtMinAtv – inConsOcupMinVeic – inFatorTrafego – hrPadraoRoteirizacao properties: nrCNPJFilial: type: string description: CNPJ da Filial a que as definições e restrições pertencem hrCorte: type: string format: date-time description: horário de Corte qtTempoAtendPad: type: string format: date-time description: Quantidadade Padr�o de Tempo de Atendimento qtTempoAlertaAtraso: type: string format: date-time description: Proximidade de tempo até a previsão de entrega para ficar em alerta no painel. Ex: 30 minutos qtTempoAltRotExec: type: string format: date-time description: Quantidade de tempo até que o roteiro do dia seja acionado como em execução. Ex: 1h antes. qtTempoAltRotFin: type: string format: date-time description: Quantidade de tempo até que o roteiro do dia seja acionado como em finalização. Ex: 1h antes. inConsQtMinAtv: type: integer format: int64 description: Considerar quantidade mínima de atividades. Valor existente no cadastro do veículo. inConsOcupMinVeic: type: integer format: int64 description: Considerar ocupação mínima do veículo. Valor existente no cadastro do veículo. inConsJornadaTrab: type: integer format: int64 description: Considerar jornada de trabalho. Valor do cadastro de motorista. inConsJanela: type: integer format: int64 description: Considerar janela de atividade. Valor do cadastro de atividade. inConsDtAgendamento: type: integer format: int64 description: Considerar data de agendamento. vlGasolina: type: number format: double description: Custo da Gasolina. Ex: 3.60/litro. vlEtanol: type: number format: double description: Custo do Etanol. Ex: 2.90/litro. vlDiesel: type: number format: double description: Custo do Diesel. Ex: 3.20/litro. vlGnv: type: number format: double description: Custo do G�s Natural. Ex: 2.95/m³. inRestricaoDestino: type: integer format: int64 description: Considera restrição de destino inRestricaoRegiao: type: integer format: int64 description: Considera restrição de regi�o inRestricaoOperacao: type: integer format: int64 description: Considera restrição de operação inRestricaoTpCarga: type: integer format: int64 description: Considera restrição de tipo de carga inFatorTrafego: type: integer format: int64 description: Fator Tráfego. Ex: Leve, Moderado, Intenso, Congestionado inRoteirizacao: type: integer format: int64 description: Considera roteirização automática 1 ou manual 0 inModTransp: type: integer format: int64 description: Modalidade de Transporte 0 – Fracionada 1 – Lotação inTpSelecaoVeic: type: integer format: int64 description: Tipo de seleção do veículo na roteirização. 1- Por Placa, 0- Por Grupo de Veículo. hrPadraoRoteirizacao: type: string format: date-time description: Horário sugerido após selecionar uma filial durante o processo de roteirização. inPermiteFinRotSemOcorr: type: integer format: int64 description: Permite Finalizar rota sem ocorrência inRestricaoViaPavimentada: type: integer format: int64 description: Considerar restrições de vias pavimentadas inOrdListaAtvPorLocal: type: integer format: int64 description: Ordenar listagem de atividades por localização inAgeIniciarRotas: type: integer format: int64 description: Agendamento para iniciar rotas automaticamente – 0=Desativado, 1=Ativado inAgeFinalizarRotas: type: integer format: int64 description: Agendamento para finalizar rotas automaticamente – 0=Desativado, 1=Ativado 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 certificadoDigital: type: object allOf: – #/definitions/CertificadoDigitalRec description: Certificado digital da filial operadoraPedagio: type: object allOf: – #/definitions/DefinicaoOperadoraPedagioRec description: Definições de operadora e credenciais para cálculo de pedágio 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, caso ocorra default: description: Error response schema: #/definitions/genericError /empresas/actions/alteraDefinicoes: post: description: Edição de Definições e restrições tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial – qtTempoAtendPad – qtTempoAlertaAtraso – qtTempoAltRotExec – qtTempoAltRotFin – inConsQtMinAtv – inConsOcupMinVeic – inFatorTrafego – hrPadraoRoteirizacao properties: nrCNPJFilial: type: string description: CNPJ da Filial a que as definições e restrições pertencem hrCorte: type: string format: date-time description: horário de Corte qtTempoAtendPad: type: string format: date-time description: Quantidadade Padr�o de Tempo de Atendimento qtTempoAlertaAtraso: type: string format: date-time description: Proximidade de tempo até a previsão de entrega para ficar em alerta no painel. Ex: 30 minutos qtTempoAltRotExec: type: string format: date-time description: Quantidade de tempo até que o roteiro do dia seja acionado como em execução. Ex: 1h antes. qtTempoAltRotFin: type: string format: date-time description: Quantidade de tempo até que o roteiro do dia seja acionado como em finalização. Ex: 1h antes. inConsQtMinAtv: type: integer format: int64 description: Considerar quantidade mínima de atividades. Valor existente no cadastro do veículo. inConsOcupMinVeic: type: integer format: int64 description: Considerar ocupação mínima do veículo. Valor existente no cadastro do veículo. inConsJornadaTrab: type: integer format: int64 description: Considerar jornada de trabalho. Valor do cadastro de motorista. inConsJanela: type: integer format: int64 description: Considerar janela de atividade. Valor do cadastro de atividade. inConsDtAgendamento: type: integer format: int64 description: Considerar data de agendamento. vlGasolina: type: number format: double description: Custo da Gasolina. Ex: 3.60/litro. vlEtanol: type: number format: double description: Custo do Etanol. Ex: 2.90/litro. vlDiesel: type: number format: double description: Custo do Diesel. Ex: 3.20/litro. vlGnv: type: number format: double description: Custo do G�s Natural. Ex: 2.95/m³. inRestricaoDestino: type: integer format: int64 description: Considera restrição de destino inRestricaoRegiao: type: integer format: int64 description: Considera restrição de regi�o inRestricaoOperacao: type: integer format: int64 description: Considera restrição de operação inRestricaoTpCarga: type: integer format: int64 description: Considera restrição de tipo de carga inFatorTrafego: type: integer format: int64 description: Fator Tráfego. Ex: Sem Trânsito, Leve, Moderado e Intenso inRoteirizacao: type: integer format: int64 description: Considera roteirização automática 1 ou manual 0 inModTransp: type: integer format: int64 description: Modalidade de Transporte 0 – Fracionada 1 – Lotação inTpSelecaoVeic: type: integer format: int64 description: Tipo de seleção do veículo na roteirização. 1- Por Placa, 0- Por Grupo de Veículo. hrPadraoRoteirizacao: type: string format: date-time description: Horário sugerido após selecionar uma filial durante o processo de roteirização. inPermiteFinRotSemOcorr: type: integer format: int64 description: Permite Finalizar rota sem ocorrência inRestricaoViaPavimentada: type: integer format: int64 description: Considerar restrições de vias pavimentadas inOrdListaAtvPorLocal: type: integer format: int64 description: Ordenar listagem de atividades por localização inAgeIniciarRotas: type: integer format: int64 description: Agendamento para iniciar rotas automaticamente – 0=Desativado, 1=Ativado inAgeFinalizarRotas: type: integer format: int64 description: Agendamento para finalizar rotas automaticamente – 0=Desativado, 1=Ativado 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 certificadoDigital: type: object allOf: – #/definitions/CertificadoDigitalRec description: operadoraPedagio: type: object allOf: – #/definitions/DefinicaoOperadoraPedagioRec description: 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, caso ocorra default: description: Error response schema: #/definitions/genericError /empresas/actions/iniciarDefinicoes: post: description: Altera definições de agendamentos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: inAgeIniciarRotas: type: integer format: int64 description: Agendamento para iniciar rotas automaticamente – 0=Desativado, 1=Ativado inAgeFinalizarRotas: type: integer format: int64 description: Agendamento para finalizar rotas automaticamente – 0=Desativado, 1=Ativado 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, caso ocorra default: description: Error response schema: #/definitions/genericError /empresas/actions/alteraRegrasAtend: post: description: Edição de Regras de Atendimento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial – inGrauConf – inAnaliseGrauConf – qtKmRaio – inAnaliseKmRaio properties: nrCNPJFilial: type: string description: CNPJ da Filial a que as regras de atendimento pertencem inGrauConf: type: integer format: int64 description: Grau de Confiança mínimo para considerar uma atividade como Aceita, sendo: 0-Nulo, 1-Baixo, 2-Médio, 3-Alto e 4-Manual inAnaliseGrauConf: type: integer format: int64 description: Caso grau mínimo não atingido qtKmRaio: type: number format: double description: Raio máximo em kilómetros em que se encontra uma atividade inAnaliseKmRaio: type: integer format: int64 description: Caso raio máximo ultrapassado 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, caso ocorra default: description: Error response schema: #/definitions/genericError /empresas/actions/deletaDefinicoes: post: description: Exclusão de Definições e restrições – Primitiva depreciada 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: Descrição do erro, caso ocorra default: description: Error response schema: #/definitions/genericError /empresas/actions/insereDestinos: post: description: Cadastro de Destinos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – destinos properties: destinos: type: array items: type: object allOf: – #/definitions/recDestino minimum: 1 description: Destinos 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/recDestino minimum: 1 description: Destinos que não obtiveram êxito na operação. listaOk: type: array items: type: object allOf: – #/definitions/recDestino minimum: 1 description: Destinos que obtiveram êxito na operação. default: description: Error response schema: #/definitions/genericError /empresas/actions/insereHistoricosEnderecos: post: description: Cadastro de histórico de endereços tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – historicosEnderecos properties: historicosEnderecos: type: array items: type: object allOf: – #/definitions/recHistoricoEndereco minimum: 1 description: Histórico de endereços 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/recHistoricoEndereco minimum: 1 description: Históricos não inseridos listaOk: type: array items: type: object allOf: – #/definitions/recHistoricoEndereco minimum: 1 description: Históricos inseridos default: description: Error response schema: #/definitions/genericError /empresas/actions/alteraDestinos: post: description: Edição de Destino tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – destinos properties: destinos: type: array items: type: object allOf: – #/definitions/recDestino minimum: 1 description: Destinos recalcGrauConfianca: type: boolean description: Recalcular o grau de confiança com os valores fornecidos. Padrão: true inPermAltDestAtivRot: type: boolean description: Permitir alterar destino com atividades já roteirizadas associadas. Padrão: false responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaNOK – listaOk – listaAtvNOK – listaAtvOk 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/recDestino minimum: 1 description: Destinos que não obtiveram êxito na operação. listaOk: type: array items: type: object allOf: – #/definitions/recDestino minimum: 1 description: Destinos que obtiveram êxito na operação. listaAtvNOK: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Atividades que não obtiveram êxito na operação. listaAtvOk: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: Atividades que obtiveram êxito na operação. default: description: Error response schema: #/definitions/genericError /empresas/actions/deletaDestinos: post: description: Exclusão de Destinos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdDestino properties: cdDestino: type: string description: Código do destino 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. default: description: Error response schema: #/definitions/genericError /empresas/actions/deletaHistoricosEnderecos: post: description: Exclusão de históricos de destinos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdHistoricoEndereco properties: cdHistoricoEndereco: type: integer format: int64 description: Código do endereço do destino cdDestino: type: string description: Código do destino 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. default: description: Error response schema: #/definitions/genericError /empresas/actions/insereHorariosDestino: post: description: Inclusão de horários e dias úteis no destino tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – horarios properties: horarios: type: array items: type: object allOf: – #/definitions/recHorarioDestino minimum: 1 description: Lista de horários a serem inseridos 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/recHorarioDestino minimum: 1 description: Destinos que não obtiveram êxito na operação. listaOk: type: array items: type: object allOf: – #/definitions/recHorarioDestino minimum: 1 description: Destinos que obtiveram êxito na operação. default: description: Error response schema: #/definitions/genericError /empresas/actions/alteraHorariosDestino: post: description: Altera��o de horários e dias úteis no destino tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – horarios properties: horarios: type: array items: type: object allOf: – #/definitions/recHorarioDestino minimum: 1 description: Lista de horários a serem alterados 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/recHorarioDestino minimum: 1 description: Destinos que não obtiveram êxito na operação. listaOk: type: array items: type: object allOf: – #/definitions/recHorarioDestino minimum: 1 description: Destinos que obtiveram êxito na operação. default: description: Error response schema: #/definitions/genericError /empresas/actions/deletaHorariosDestino: post: description: Exclusão de horários do destino tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdDestino properties: cdDestino: type: string description: Código do destino cdHorario: type: integer format: int64 description: Código do horário a ser excluído 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. default: description: Error response schema: #/definitions/genericError /empresas/actions/insereRestricoesDestino: post: description: Inclusão de restricoes e dias úteis no destino 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/recRestricaoDestino minimum: 1 description: Lista de restrições a serem inseridos responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaOk properties: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro ocorrido. listaOk: type: array items: type: object allOf: – #/definitions/recRestricaoDestino minimum: 1 description: Destinos que obtiveram êxito na operação. default: description: Error response schema: #/definitions/genericError /empresas/actions/deletaRestricoesDestino: post: description: Exclusão de horários do destino tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdDestino properties: cdDestino: type: string description: Código do destino cdRestricao: type: integer format: int64 description: Código da restrição a ser excluída 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. default: description: Error response schema: #/definitions/genericError /empresas/actions/inserirMCEPAPFL: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idPapel – nrCNPJ properties: idPapel: type: string description: nrCNPJ: type: string description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /empresas/actions/inserirFiliaisPapel: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: inPermAltRoteirizacao: type: integer format: int64 description: inPermAltRestricao: type: integer format: int64 description: inPermAltRotaExec: type: integer format: int64 description: inPermiteFinRotSemOcorr: type: integer format: int64 description: inPermAltEmpresa: type: integer format: int64 description: filiais: type: array items: type: object allOf: – #/definitions/recFilial description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /empresas/actions/deletarMCEPAPFL: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idPapel – nrCNPJ properties: idPapel: type: string description: nrCNPJ: type: string description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /empresas/actions/deletarFiliaisPapel: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /empresas/actions/deletarPapeisFilial: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJ properties: nrCNPJ: type: string description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /empresas/actions/inicializaPapelPadrao: 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: default: description: Error response schema: #/definitions/genericError definitions: TipoAmbiente: description: type: string enum: – HOMOLOGACAO – PRODUCAO 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 simpleData: description: type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro keyValue: description: type: object required: – key – value properties: key: type: string description: Nome do campo filtro que está sendo enviado como parâmetro value: type: string description: Valor do campo filtro que está sendo enviado como parâmetro DefinicaoOperadoraPedagioRec: description: type: object required: – operadoraPedagio – ambiente properties: operadoraPedagio: type: string description: ambiente: type: string allOf: – #/definitions/TipoAmbiente description: usuario: type: string description: senha: type: string description: CertificadoDigitalRec: description: type: object required: – certificado – senha properties: certificado: type: string format: byte description: senha: type: string description: totaisDestinosParaGeocodificar: description: type: object properties: totalAlto: type: integer format: int64 description: totalMedio: type: integer format: int64 description: totalBaixo: type: integer format: int64 description: totalNulo: type: integer format: int64 description: totalManual: type: integer format: int64 description: totalDestinosParaGeocodificar: type: integer format: int64 description: recDestino: description: type: object properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial description: Filiais do destino cdDestino: type: string description: Código do destino nrCpfCnpj: type: string description: Código de Cpf ou Cnpj dsDescricao: type: string description: Descrição do destino dsLocal: type: string description: Logradouro destino (cliente) nrCep: type: integer format: int64 description: 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: 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 dsUsuario: type: string description: Usuario da alteração recHistoricoEndereco: description: Histórico de endereços type: object properties: cdDestino: type: string description: Código do destino dsLocal: type: string description: Logradouro destino (cliente) nrCep: type: integer format: int64 description: Cep do 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 de origem 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 dtInicio: type: string format: date-time description: Data inicial do histórico de endereço do destino dtFim: type: string format: date-time description: Data final do histórico de endereço do destino dsUsuario: type: string description: Usuario da alteração recEmpresa: description: type: object properties: cdEmpresa: type: integer format: int64 description: dsEmpresa: type: string description: 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: string 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: definicoes: type: object allOf: – #/definitions/MCEDEFRec description: MCEDEFRec: description: type: object required: – nrCNPJFilial – qtTempoAtendPad – qtTempoAlertaAtraso – qtTempoAltRotExec – qtTempoAltRotFin – inConsQtMinAtv – inConsOcupMinVeic – inFatorTrafego – hrPadraoRoteirizacao properties: nrCNPJFilial: type: string description: hrCorte: type: string format: date-time description: qtTempoAtendPad: type: string format: date-time description: qtTempoAlertaAtraso: type: string format: date-time description: qtTempoAltRotExec: type: string format: date-time description: qtTempoAltRotFin: type: string format: date-time description: inConsQtMinAtv: type: integer format: int64 description: inConsOcupMinVeic: type: integer format: int64 description: inConsJornadaTrab: type: integer format: int64 description: inConsJanela: type: integer format: int64 description: inRestricaoDestino: type: integer format: int64 description: inRestricaoRegiao: type: integer format: int64 description: inRestricaoOperacao: type: integer format: int64 description: inRestricaoTpCarga: type: integer format: int64 description: inRestricaoViaPavimentada: type: integer format: int64 description: Considerar restrições de vias pavimentadas inConsDtAgendamento: type: integer format: int64 description: Considerar data agendamento vlGasolina: type: number format: double description: vlEtanol: type: number format: double description: vlDiesel: type: number format: double description: vlGnv: type: number format: double description: inFatorTrafego: type: integer format: int64 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: inRoteirizacao: type: integer format: int64 description: inPermiteRoteirizar: type: integer format: int64 description: inPermiteFinRotSemOcorr: type: integer format: int64 description: inOrdListaAtvPorLocal: type: integer format: int64 description: Ordenar listagem de atividades por localização inTpSelecaoVeic: type: integer format: int64 description: Tipo de seleção do veículo na roteirização. 1- Por Placa, 0- Por Grupo de Veículo. hrPadraoRoteirizacao: type: string format: date-time description: Horário sugerido após selecionar uma filial durante o processo de roteirização. inModTransp: type: integer format: int64 description: Modalidade de Transporte 0 – Fracionada 1 – Lotação inAgeIniciarRotas: type: integer format: int64 description: Agendamento para iniciar rotas automaticamente – 0=Desativado, 1=Ativado inAgeFinalizarRotas: type: integer format: int64 description: Agendamento para finalizar rotas automaticamente – 0=Desativado, 1=Ativado 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 operadoraPedagio: type: object allOf: – #/definitions/DefinicaoOperadoraPedagioRec description: contemCertificadoDigital: type: boolean description: 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 MCEATVRec: description: type: object required: – inAtividade – dsDestinatario – qtPeso – dsNrDocto – dtPrazoEntr properties: nrCNPJFilial: type: string 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: 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: cdOperacao: type: integer format: int64 description: dsObservacao: type: string 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: 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: qtKmPlanejada: type: number format: double description: qtTempoEstimado: type: number format: double description: dtAgendamento: type: string format: date-time description: dtInclusao: type: string format: date-time description: recGrauConfiancaIn: description: type: object properties: dsLogradouro: type: string description: dsLogradouroOrig: type: string description: cdNumero: type: string description: cdNumeroOrig: type: string description: dsBairro: type: string description: dsBairroOrig: type: string description: dsCidade: type: string description: dsCidadeOrig: type: string description: dsEstado: type: string description: dsEstadoOrig: type: string description: dsPais: type: string description: dsPaisOrig: type: string description: dsLat: type: string description: dsLatOrig: type: string description: dsLong: type: string description: dsLongOrig: type: string description: nrCep: type: string description: nrCepOrig: type: string description: recGrauConfiancaOut: description: type: object required: – inGrauConf – dsGrauConf properties: inGrauConf: type: integer format: int64 description: Código do grau de confiança dsGrauConf: type: string description: Descrição do grau de confiança recRecalculaGrauConfianca: description: type: object required: – totalDestinosVerificados – totalDestinosGrauAumentados – alto – medio – baixo – nulo – baixoParaAlto – baixoParaMedio – medioParaAlto properties: totalDestinosVerificados: type: integer format: int64 description: totalDestinosGrauAumentados: type: integer format: int64 description: alto: type: string description: medio: type: string description: baixo: type: string description: nulo: type: string description: baixoParaAlto: type: string description: baixoParaMedio: type: string description: medioParaAlto: type: string description: recHorarioDestino: description: Registro referente aos horários e dias de semana úteis dos destinos type: object required: – cdDestino properties: cdDestino: type: string description: Código do destino 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 recRestricaoDestino: description: Vinculação entre restrições e destinos type: object required: – cdDestino – cdRestricao properties: cdDestino: type: string description: Código do destino cdRestricao: type: integer format: int64 description: Código da restrição vinculada ao destino dsRestricao: type: string description: Descrição da restrição inTpRestricao: type: integer format: int64 description: Tipo da restrição OperadoraPedagioRec: description: Registro para retorno de lista de operadoras de pedágio type: object required: – nome – valor properties: nome: type: string description: Nome da operadora valor: type: string description: Valor no enumerador OperadoraPedagio tipoAutenticacao: type: string description: Tipo de autenticação do webservice (USUARIO_SENHA / CERTIFICADO_DIGITAL) recFilialCompl: 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: definicoes: type: object allOf: – #/definitions/MCEDEFRec description: recMCEPAPFL: description: type: object required: – idPapel – nrCNPJ properties: idPapel: type: string description: nrCNPJ: type: string description: recMCEPAPPE: description: type: object required: – idPapel properties: idPapel: type: string description: inPermAltRoteirizacao: type: integer format: int64 description: inPermAltRestricao: type: integer format: int64 description: inPermAltRotaExec: type: integer format: int64 description: inPermiteFinRotSemOcorr: type: integer format: int64 description: inPermAltEmpresa: type: integer format: int64 description: 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