2.0info: 4.1.4 veiculos x-senior-domain: tmsentregas x-senior-domain-path: tmsentregas x-senior-service-path: veiculos 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: /veiculos/queries/insereVeiculo: post: description: Cadastro de Veículo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial – nrPlaca – inSituacao properties: nrCNPJFilial: type: string description: Código identificador da empresa cdGrupoVeiculo: type: integer format: int64 description: Código identificador do grupo do veículo nrPlaca: type: string description: Placa Veículo inSituacao: type: integer format: int64 description: Situação do Veículo dsRegiaoAtend: type: string description: Descrição da região de Atendimento dsVeiculo: type: string description: Descrição do veículo cdMotorista: type: integer format: int64 description: Motorista padrão deste veículo cdRastreadora: type: integer format: int64 description: código da rastreadora cdVeiculoRastreadora: type: string description: código do veículo na rastreadora responses: 200: description: Ok schema: type: object required: – ok – dsErro – nrPlaca properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: nrPlaca: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Cadastro de Veículo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: Código identificador da empresa in: query required: true type: string – name: cdGrupoVeiculo description: Código identificador do grupo do veículo in: query type: integer format: int64 – name: nrPlaca description: Placa Veículo in: query required: true type: string – name: inSituacao description: Situação do Veículo in: query required: true type: integer format: int64 – name: dsRegiaoAtend description: Descrição da região de Atendimento in: query type: string – name: dsVeiculo description: Descrição do veículo in: query type: string – name: cdMotorista description: Motorista padrão deste veículo in: query type: integer format: int64 – name: cdRastreadora description: código da rastreadora in: query type: integer format: int64 – name: cdVeiculoRastreadora description: código do veículo na rastreadora in: query type: string responses: 200: description: Ok schema: type: object required: – ok – dsErro – nrPlaca properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: nrPlaca: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/insereGrupoVeiculo: post: description: Cadastro de Grupo de Veículos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filiais – dsGrupoVeiculo – inHoraTrabalho properties: filiais: type: array items: type: string minimum: 1 description: Lista com o CNPJ de filiais dsGrupoVeiculo: type: string description: qtPeso: type: number format: double description: maximum: 9999999999 qtMetrosCubicos: type: number format: double description: maximum: 9999999999 qtCustoKm: type: number format: double description: maximum: 9999999999 qtCustoHora: type: number format: double description: maximum: 9999999999 qtCustoRota: type: number format: double description: maximum: 9999999999 qtEixos: type: integer format: int64 description: qtMinAtv: type: integer format: int64 description: qtOcupMinPeso: type: number format: double description: maximum: 9999999999 qtOcupMinMetragemCubica: type: number format: double description: maximum: 9999999999 inColeta: type: integer format: int64 description: inEntrega: type: integer format: int64 description: inServico: type: integer format: int64 description: inTpVeiculo: type: integer format: int64 description: inTpCarroceria: type: integer format: int64 description: hrTrabalhoIni: type: string format: date-time description: Hora Início de trabalho hrTrabalhoFim: type: string format: date-time description: Hora Final de trabalho hrIntervaloIni: type: string format: date-time description: Hora Início do Intervalo de trabalho hrIntervaloFim: type: string format: date-time description: Hora Final do Intervalo de trabalho qtVeiculos: type: integer format: int64 description: inHoraTrabalho: type: integer format: int64 description: Tipo de Horário – Fixo ou Dinâmico – Se Fixo – vai utilizar o hrTrabalhoIni, hrTrabalhoFim, hrIntervaloIni, hrIntervaloFim – Se Dinâmico – qtTempoTrabalho, qtTempoIntervalo qtTempoTrabalho: type: string format: date-time description: Qtde Tempo de Trabalho qtTempoIntervalo: type: string format: date-time description: Qtde Tempo de Intervalo responses: 200: description: Ok schema: type: object required: – ok – dsErro – cdGrupoVeiculo properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: cdGrupoVeiculo: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Cadastro de Grupo de Veículos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filiais description: Lista com o CNPJ de filiais in: query required: true type: array items: type: string minimum: 1 – name: dsGrupoVeiculo description: in: query required: true type: string – name: qtPeso description: in: query type: number format: double – name: qtMetrosCubicos description: in: query type: number format: double – name: qtCustoKm description: in: query type: number format: double – name: qtCustoHora description: in: query type: number format: double – name: qtCustoRota description: in: query type: number format: double – name: qtEixos description: in: query type: integer format: int64 – name: qtMinAtv description: in: query type: integer format: int64 – name: qtOcupMinPeso description: in: query type: number format: double – name: qtOcupMinMetragemCubica description: in: query type: number format: double – name: inColeta description: in: query type: integer format: int64 – name: inEntrega description: in: query type: integer format: int64 – name: inServico description: in: query type: integer format: int64 – name: inTpVeiculo description: in: query type: integer format: int64 – name: inTpCarroceria description: in: query type: integer format: int64 – name: hrTrabalhoIni description: Hora Início de trabalho in: query type: string format: date-time – name: hrTrabalhoFim description: Hora Final de trabalho in: query type: string format: date-time – name: hrIntervaloIni description: Hora Início do Intervalo de trabalho in: query type: string format: date-time – name: hrIntervaloFim description: Hora Final do Intervalo de trabalho in: query type: string format: date-time – name: qtVeiculos description: in: query type: integer format: int64 – name: inHoraTrabalho description: Tipo de Horário – Fixo ou Dinâmico – Se Fixo – vai utilizar o hrTrabalhoIni, hrTrabalhoFim, hrIntervaloIni, hrIntervaloFim – Se Dinâmico – qtTempoTrabalho, qtTempoIntervalo in: query required: true type: integer format: int64 – name: qtTempoTrabalho description: Qtde Tempo de Trabalho in: query type: string format: date-time – name: qtTempoIntervalo description: Qtde Tempo de Intervalo in: query type: string format: date-time responses: 200: description: Ok schema: type: object required: – ok – dsErro – cdGrupoVeiculo properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: cdGrupoVeiculo: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/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 /veiculos/queries/buscaVeiculos: post: description: Pesquisa de Veículos 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 empresa cdGrupoVeiculo: type: integer format: int64 description: Código identificador do grupo do veículo. Caso informado valor menor ou igual a zero, retorna todos. inSituacao: type: integer format: int64 description: Situação do Veículo. Caso informado valor menor que zero, busca com todas as situações. nrPlaca: type: string description: Placa do veículo. listaPlacas: type: array items: type: string description: Placas de veículos: utilizado para pesquisa de mais de um veículo por placa carregaDepFilial: type: boolean description: Indicador se deseja retornar os dados da filial associada ao veículo default: true carregaDepMotorista: type: boolean description: Indicador se deseja retornar os dados do motorista associado ao veículo default: true carregaDepGrupo: type: boolean description: Indicador se deseja retornar os dados do grupo do veículo cdMotorista: type: integer format: int64 description: Motorista vinculado ao veículo offset: type: integer format: int64 description: limit: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaResultado – ok – dsErro – totalItens properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEVEIRec minimum: 1 description: ok: type: boolean description: dsErro: type: string description: totalItens: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Veículos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: Código identificador da empresa in: query type: string – name: cdGrupoVeiculo description: Código identificador do grupo do veículo. Caso informado valor menor ou igual a zero, retorna todos. in: query type: integer format: int64 – name: inSituacao description: Situação do Veículo. Caso informado valor menor que zero, busca com todas as situações. in: query type: integer format: int64 – name: nrPlaca description: Placa do veículo. in: query type: string – name: listaPlacas description: Placas de veículos: utilizado para pesquisa de mais de um veículo por placa in: query type: array items: type: string – name: carregaDepFilial description: Indicador se deseja retornar os dados da filial associada ao veículo in: query type: boolean – name: carregaDepMotorista description: Indicador se deseja retornar os dados do motorista associado ao veículo in: query type: boolean – name: carregaDepGrupo description: Indicador se deseja retornar os dados do grupo do veículo in: query type: boolean – name: cdMotorista description: Motorista vinculado ao veículo in: query type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: limit description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado – ok – dsErro – totalItens properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEVEIRec minimum: 1 description: ok: type: boolean description: dsErro: type: string description: totalItens: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaVeiculosRastreados: post: description: Pesquisa de Veículos Rastreados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial properties: nrCNPJFilial: type: array items: type: string minimum: 1 description: Código identificador da empresa responses: 200: description: Ok schema: type: object required: – listaResultado – ok – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/veiculoRastreadoraRec minimum: 1 description: ok: type: boolean description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Veículos Rastreados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: Código identificador da empresa in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – listaResultado – ok – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/veiculoRastreadoraRec minimum: 1 description: ok: type: boolean description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaFiliaisEmpresa: post: description: Pesquisa de Filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdEmpresa: type: integer format: int64 description: nrCNPJ: type: string description: dsFilial: 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/recFilial minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Filiais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdEmpresa description: in: query type: integer format: int64 – name: nrCNPJ description: in: query type: string – name: dsFilial 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/recFilial minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaSituacaoVeiculo: post: description: Pesquisa de Veículos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: inSituacao: type: integer format: int64 description: Situação do Veículo. Caso informado valor menor que zero, busca com todas as situações. responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/inSitVeiculoRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Veículos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inSituacao description: Situação do Veículo. Caso informado valor menor que zero, busca com todas as situações. in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/inSitVeiculoRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaTiposCombustivel: post: description: Pesquisa de Tipos de Combustível tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: inCombustivel: type: integer format: int64 description: Tipos de combustivel. Caso informado valor menor que zero, busca com todos os tipos de combutiveis. responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/inCombustivelRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Tipos de Combustível tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inCombustivel description: Tipos de combustivel. Caso informado valor menor que zero, busca com todos os tipos de combutiveis. in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/inCombustivelRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaGruposVeiculosPorDescricao: post: description: Pesquisa grupos de veículos por filial e descrição, retornando lista com o código e descrição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – descricao properties: cnpjFilial: type: string description: CNPJ da filial descricao: type: string description: Valor da busca informada responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/recCodigoDescricaoGrupoVeiculo minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa grupos de veículos por filial e descrição, retornando lista com o código e descrição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cnpjFilial description: CNPJ da filial in: query type: string – name: descricao description: Valor da busca informada in: query required: true type: string responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/recCodigoDescricaoGrupoVeiculo minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaGruposVeiculos: post: description: Pesquisa de Grupo de Veículos 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 empresa cdGrupoVeiculo: type: integer format: int64 description: Código identificador do grupo do veículo. Caso informado valor menor ou igual a zero, retorna todos. dsGrupoVeiculo: type: string description: inColeta: type: integer format: int64 description: inEntrega: type: integer format: int64 description: inServico: type: integer format: int64 description: nrPlaca: type: string description: carregaDepFilial: type: boolean description: Indicador se deseja retornar os dados da filial associada ao veículo hrTrabalhoIni: type: integer format: int64 description: hrTrabalhoFim: type: integer format: int64 description: listaInTpVeiculo: type: array items: type: integer format: int64 description: offset: type: integer format: int64 description: limit: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sinaliza se a requisição terminou com sucesso dsErro: type: string description: Descrição do erro totalItens: type: integer format: int64 description: Total de grupos de veículos cadastrados listaResultado: type: array items: type: object allOf: – #/definitions/MCEGVERec minimum: 1 description: Lista de grupos de veículos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Grupo de Veículos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: Código identificador da empresa in: query type: string – name: cdGrupoVeiculo description: Código identificador do grupo do veículo. Caso informado valor menor ou igual a zero, retorna todos. in: query type: integer format: int64 – name: dsGrupoVeiculo description: in: query type: string – name: inColeta description: in: query type: integer format: int64 – name: inEntrega description: in: query type: integer format: int64 – name: inServico description: in: query type: integer format: int64 – name: nrPlaca description: in: query type: string – name: carregaDepFilial description: Indicador se deseja retornar os dados da filial associada ao veículo in: query type: boolean – name: hrTrabalhoIni description: in: query type: integer format: int64 – name: hrTrabalhoFim description: in: query type: integer format: int64 – name: listaInTpVeiculo description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: limit description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – listaResultado properties: ok: type: boolean description: Sinaliza se a requisição terminou com sucesso dsErro: type: string description: Descrição do erro totalItens: type: integer format: int64 description: Total de grupos de veículos cadastrados listaResultado: type: array items: type: object allOf: – #/definitions/MCEGVERec minimum: 1 description: Lista de grupos de veículos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaVeiculosDisponiveis: post: description: Verificar se os veículos já possuem alguma rota associada a eles no período entre a data de início da roteirização até a data final da rota. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dtInicialRota – dtFinalRota – nrCNPJFilial properties: dtInicialRota: type: string format: date-time description: dtFinalRota: type: string format: date-time description: nrCNPJFilial: type: string description: cdGrupoVeiculo: type: integer format: int64 description: nrPlaca: type: string description: inTpVeiculoLista: type: array items: type: integer format: int64 description: grupoVeiculoObrigatorio: type: boolean description: responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEVEIRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verificar se os veículos já possuem alguma rota associada a eles no período entre a data de início da roteirização até a data final da rota. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dtInicialRota description: in: query required: true type: string format: date-time – name: dtFinalRota description: in: query required: true type: string format: date-time – name: nrCNPJFilial description: in: query required: true type: string – name: cdGrupoVeiculo description: in: query type: integer format: int64 – name: nrPlaca description: in: query type: string – name: inTpVeiculoLista description: in: query type: array items: type: integer format: int64 – name: grupoVeiculoObrigatorio description: in: query type: boolean responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEVEIRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaVeiculosDisponiveisLotacao: post: description: Busca os veículos considerados disponíveis para viagens do tipo lotação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial properties: nrCNPJFilial: type: string description: cdGrupoVeiculo: type: integer format: int64 description: nrPlaca: type: string description: inTpVeiculoLista: type: array items: type: integer format: int64 description: qtPeso: type: number format: double description: qtMetrosCubicos: type: number format: double description: qtAtividades: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEVEIRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os veículos considerados disponíveis para viagens do tipo lotação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: in: query required: true type: string – name: cdGrupoVeiculo description: in: query type: integer format: int64 – name: nrPlaca description: in: query type: string – name: inTpVeiculoLista description: in: query type: array items: type: integer format: int64 – name: qtPeso description: in: query type: number format: double – name: qtMetrosCubicos description: in: query type: number format: double – name: qtAtividades description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEVEIRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaVeiculosPorTipo: post: description: Busca os veículos que o tipo informado no grupo estão entre os tipos informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inTpVeiculo properties: nrPlaca: type: string description: inTpVeiculo: type: array items: type: integer format: int64 minimum: 1 description: 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/MCEVEIRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os veículos que o tipo informado no grupo estão entre os tipos informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrPlaca description: in: query type: string – name: inTpVeiculo description: in: query required: true type: array items: type: integer format: int64 minimum: 1 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/MCEVEIRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaQtRotasEmUsoPorGrupo: post: description: Busca quantidade de veículos em uso para determinados grupos de veículos no período entre a data de início da roteirização até a data final da rota. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dtInicialRota – dtFinalRota properties: dtInicialRota: type: string format: date-time description: Procura por roteiros iniciados a partir desta data dtFinalRota: type: string format: date-time description: Procura por roteiros terminados até esta data listaCdGrupoVeiculo: type: array items: type: integer format: int64 description: Lista de grupos de veículos a serem consultados no período responses: 200: description: Ok schema: type: object required: – listaResultado – ok – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/recGrupoQtVeicEmUso minimum: 1 description: Lista Grupo – QtVeiculosEmUso ok: type: boolean description: Resultado da operação dsErro: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca quantidade de veículos em uso para determinados grupos de veículos no período entre a data de início da roteirização até a data final da rota. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dtInicialRota description: Procura por roteiros iniciados a partir desta data in: query required: true type: string format: date-time – name: dtFinalRota description: Procura por roteiros terminados até esta data in: query required: true type: string format: date-time – name: listaCdGrupoVeiculo description: Lista de grupos de veículos a serem consultados no período in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado – ok – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/recGrupoQtVeicEmUso minimum: 1 description: Lista Grupo – QtVeiculosEmUso ok: type: boolean description: Resultado da operação dsErro: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaTiposVeiculo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: inTpVeiculo: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/recTipoVeiculo minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inTpVeiculo description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/recTipoVeiculo minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaTiposVeiculosPlacas: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – arrPlacas properties: arrPlacas: type: string description: responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro – ok properties: listaResultado: type: array items: type: object allOf: – #/definitions/recPlacaTipo minimum: 1 description: dsErro: type: string description: ok: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: arrPlacas description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro – ok properties: listaResultado: type: array items: type: object allOf: – #/definitions/recPlacaTipo minimum: 1 description: dsErro: type: string description: ok: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaTiposCarroceria: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: inTpCarroceria: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/recTipoCarroceria minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inTpCarroceria description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/recTipoCarroceria minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaRestricoesCompleta: post: description: Busca restrições e suas dependências, como regras e horários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – restricoes properties: restricoes: type: array items: type: integer format: int64 minimum: 1 description: responses: 200: description: Ok schema: type: object required: – dsErro – ok – restricao properties: dsErro: type: string description: Caso tenha ocorrido algum erro, a mensagem será retornada ok: type: boolean description: False em caso de erro restricao: type: array items: type: object allOf: – #/definitions/recRestricaoCompleta minimum: 1 description: Retorna o registro com as informações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca restrições e suas dependências, como regras e horários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: restricoes description: in: query required: true type: array items: type: integer format: int64 minimum: 1 responses: 200: description: Ok schema: type: object required: – dsErro – ok – restricao properties: dsErro: type: string description: Caso tenha ocorrido algum erro, a mensagem será retornada ok: type: boolean description: False em caso de erro restricao: type: array items: type: object allOf: – #/definitions/recRestricaoCompleta minimum: 1 description: Retorna o registro com as informações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaRestricoes: post: description: Consulta de restrições tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRestricaoIni: type: integer format: int64 description: Código inicial da restrição cdRestricaoFim: type: integer format: int64 description: Código final da restrição dsRestricao: type: string description: Descrição da Restrição diasSemana: type: string description: Restrições que contenham os determinados dias da semana cdGrupoVeiculo: type: integer format: int64 description: Grupo de veículo conforme composição tipoVeiculo: type: integer format: int64 description: Tipo de veículo conforme composição tipoCarroceria: type: integer format: int64 description: Tipo de carroceria conforme composição nrPlaca: type: string description: Placa conforme composição nrFinalPlaca: type: string description: Final de placa conforme composição inTpRestricao: type: integer format: int64 description: filtra por modo de restrição 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/recRestricao minimum: 1 description: Resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de restrições tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRestricaoIni description: Código inicial da restrição in: query type: integer format: int64 – name: cdRestricaoFim description: Código final da restrição in: query type: integer format: int64 – name: dsRestricao description: Descrição da Restrição in: query type: string – name: diasSemana description: Restrições que contenham os determinados dias da semana in: query type: string – name: cdGrupoVeiculo description: Grupo de veículo conforme composição in: query type: integer format: int64 – name: tipoVeiculo description: Tipo de veículo conforme composição in: query type: integer format: int64 – name: tipoCarroceria description: Tipo de carroceria conforme composição in: query type: integer format: int64 – name: nrPlaca description: Placa conforme composição in: query type: string – name: nrFinalPlaca description: Final de placa conforme composição in: query type: string – name: inTpRestricao description: filtra por modo de restrição 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/recRestricao minimum: 1 description: Resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaComposicoesRestricao: post: description: Consulta de composições das restrições tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRestricao: type: integer format: int64 description: Código da restrição cdComposicao: type: integer format: int64 description: Código da composicao específica cdGrupoVeiculo: type: integer format: int64 description: Código do grupo de veículo tipoVeiculo: type: integer format: int64 description: Tipo de veículo específico nrPlaca: type: string description: Placa específica finalPlaca: type: string description: Número final de placa inTpCarroceria: type: integer format: int64 description: Tipo de carroceria 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/recComposicaoRestricao minimum: 1 description: Resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta de composições das restrições tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRestricao description: Código da restrição in: query type: integer format: int64 – name: cdComposicao description: Código da composicao específica in: query type: integer format: int64 – name: cdGrupoVeiculo description: Código do grupo de veículo in: query type: integer format: int64 – name: tipoVeiculo description: Tipo de veículo específico in: query type: integer format: int64 – name: nrPlaca description: Placa específica in: query type: string – name: finalPlaca description: Número final de placa in: query type: string – name: inTpCarroceria description: Tipo de carroceria 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/recComposicaoRestricao minimum: 1 description: Resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaPosicoesVeiculos: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: listaNrPlaca: type: array items: type: string description: inTpTecnologia: type: integer format: int64 description: inAmbiente: type: integer format: int64 description: offset: type: integer format: int64 description: limit: type: integer format: int64 description: ordenacao: type: string description: ASC ou DESC dataInicialRastreio: type: string format: date-time description: datatFinalRastreio: type: string format: date-time description: 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/posicaoVeiculoRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: listaNrPlaca description: in: query type: array items: type: string – name: inTpTecnologia description: in: query type: integer format: int64 – name: inAmbiente description: in: query type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: limit description: in: query type: integer format: int64 – name: ordenacao description: ASC ou DESC in: query type: string – name: dataInicialRastreio description: in: query type: string format: date-time – name: datatFinalRastreio description: in: query type: string format: date-time 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/posicaoVeiculoRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/inserePosicaoVeiculo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrPlaca – dsLatitude – dsLongitude – dsRua – dsCidade – dsUf properties: nrPlaca: type: string description: dsLatitude: type: string description: dsLongitude: type: string description: dsRua: type: string description: dsCidade: type: string description: dsUf: type: string description: qtVelocidade: type: integer format: int64 description: dtPosicao: type: string format: date-time description: dtPacote: type: string format: date-time description: kmPosicao: type: integer format: int64 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/posicaoVeiculoRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrPlaca description: in: query required: true type: string – name: dsLatitude description: in: query required: true type: string – name: dsLongitude description: in: query required: true type: string – name: dsRua description: in: query required: true type: string – name: dsCidade description: in: query required: true type: string – name: dsUf description: in: query required: true type: string – name: qtVelocidade description: in: query type: integer format: int64 – name: dtPosicao description: in: query type: string format: date-time – name: dtPacote description: in: query type: string format: date-time – name: kmPosicao description: in: query type: integer format: int64 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/posicaoVeiculoRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/alteraPosicaoVeiculo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdPosicao properties: cdPosicao: type: integer format: int64 description: nrPlaca: type: string description: dsLatitude: type: string description: dsLongitude: type: string description: dsRua: type: string description: dsCidade: type: string description: dsUf: type: string description: qtVelocidade: type: integer format: int64 description: dtPosicao: type: string format: date-time description: dtPacote: type: string format: date-time description: kmPosicao: type: integer format: int64 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/posicaoVeiculoRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdPosicao description: in: query required: true type: integer format: int64 – name: nrPlaca description: in: query type: string – name: dsLatitude description: in: query type: string – name: dsLongitude description: in: query type: string – name: dsRua description: in: query type: string – name: dsCidade description: in: query type: string – name: dsUf description: in: query type: string – name: qtVelocidade description: in: query type: integer format: int64 – name: dtPosicao description: in: query type: string format: date-time – name: dtPacote description: in: query type: string format: date-time – name: kmPosicao description: in: query type: integer format: int64 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/posicaoVeiculoRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/deletaPosicaoVeiculo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdPosicao properties: cdPosicao: type: integer format: int64 description: 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/posicaoVeiculoRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdPosicao description: in: query required: true 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/posicaoVeiculoRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/integrarPosicoesVeiculos: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRastreadora: type: integer format: int64 description: Código da rastreadora, caso null, integra com todas as rastreadoras cadastradas. responses: 200: description: Ok schema: type: object required: – ok – dsIntegracao – listaResultado properties: ok: type: boolean description: dsIntegracao: type: string description: listaResultado: type: array items: type: object allOf: – #/definitions/integrarPosicoesVeiculosRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRastreadora description: Código da rastreadora, caso null, integra com todas as rastreadoras cadastradas. in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsIntegracao – listaResultado properties: ok: type: boolean description: dsIntegracao: type: string description: listaResultado: type: array items: type: object allOf: – #/definitions/integrarPosicoesVeiculosRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaVeiculosRastreadoras: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: listaCdRastreadora: type: array items: type: integer format: int64 description: inTpTecnologia: type: integer format: int64 description: inAmbiente: type: integer format: int64 description: offset: type: integer format: int64 description: limit: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – ok – listaResultado properties: ok: type: boolean description: listaResultado: type: array items: type: object allOf: – #/definitions/veiculoRastreadoraRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: listaCdRastreadora description: in: query type: array items: type: integer format: int64 – name: inTpTecnologia description: in: query type: integer format: int64 – name: inAmbiente description: in: query type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: limit description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – listaResultado properties: ok: type: boolean description: listaResultado: type: array items: type: object allOf: – #/definitions/veiculoRastreadoraRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/alteraVeiculoRastreadora: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrPlaca properties: nrPlaca: type: string description: kmInicial: type: integer format: int64 description: kmAtual: type: integer format: int64 description: cdRastreadora: type: integer format: int64 description: cdVeiculoRastreadora: type: string description: dtUltPosicao: type: string format: date-time description: dsLatitude: type: string description: dsLongitude: 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/veiculoRastreadoraRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrPlaca description: in: query required: true type: string – name: kmInicial description: in: query type: integer format: int64 – name: kmAtual description: in: query type: integer format: int64 – name: cdRastreadora description: in: query type: integer format: int64 – name: cdVeiculoRastreadora description: in: query type: string – name: dtUltPosicao description: in: query type: string format: date-time – name: dsLatitude description: in: query type: string – name: dsLongitude description: in: query 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/veiculoRastreadoraRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/deletaVeiculoRastreadora: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrPlaca properties: nrPlaca: type: string description: 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 get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrPlaca description: in: query required: true type: string 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 /veiculos/queries/buscaRastreadoras: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRastreadora: type: integer format: int64 description: dsRastreadora: type: string description: inAmbiente: type: integer format: int64 description: inTpTecnologia: type: integer format: int64 description: dsEndWebService: type: string description: dsUsuario: type: string description: dsSenha: type: string description: 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/RVERASRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRastreadora description: in: query type: integer format: int64 – name: dsRastreadora description: in: query type: string – name: inAmbiente description: in: query type: integer format: int64 – name: inTpTecnologia description: in: query type: integer format: int64 – name: dsEndWebService description: in: query type: string – name: dsUsuario description: in: query type: string – name: dsSenha description: in: query type: string 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/RVERASRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaEngates: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdEngate: type: integer format: int64 description: nrPlacaVeiculo: type: string description: nrPlacaReboque: type: string description: dtEngate: type: string format: date-time description: queryDecoder: type: string description: 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/MCEENGRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdEngate description: in: query type: integer format: int64 – name: nrPlacaVeiculo description: in: query type: string – name: nrPlacaReboque description: in: query type: string – name: dtEngate description: in: query type: string format: date-time – name: queryDecoder description: in: query type: string 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/MCEENGRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaVeiculosNaoEngatados: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inTpVeiculo properties: nrPlaca: type: string description: inTpVeiculo: type: array items: type: integer format: int64 minimum: 1 description: 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/MCEVEIRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrPlaca description: in: query type: string – name: inTpVeiculo description: in: query required: true type: array items: type: integer format: int64 minimum: 1 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/MCEVEIRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/queries/buscaVeiculoEngatado: post: description: Verifica se existe um veículo engatado a placa informada e o retorna caso exista tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrPlaca properties: nrPlaca: 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/MCEVEIRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se existe um veículo engatado a placa informada e o retorna caso exista tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrPlaca 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/MCEVEIRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/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 /veiculos/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 /veiculos/actions/alteraGrupoVeiculo: post: description: Edição de Grupo de Veículo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filiais – cdGrupoVeiculo – dsGrupoVeiculo – inHoraTrabalho properties: filiais: type: array items: type: string minimum: 1 description: Lista com o CNPJ de filiais cdGrupoVeiculo: type: integer format: int64 description: Código identificador do grupo do veículo dsGrupoVeiculo: type: string description: qtPeso: type: number format: double description: qtMetrosCubicos: type: number format: double description: qtCustoKm: type: number format: double description: qtCustoHora: type: number format: double description: qtCustoRota: type: number format: double description: qtEixos: type: integer format: int64 description: qtMinAtv: type: integer format: int64 description: qtOcupMinPeso: type: number format: double description: qtOcupMinMetragemCubica: type: number format: double description: inColeta: type: integer format: int64 description: inEntrega: type: integer format: int64 description: inServico: type: integer format: int64 description: inTpVeiculo: type: integer format: int64 description: inTpCarroceria: type: integer format: int64 description: hrTrabalhoIni: type: string format: date-time description: Hora Início de trabalho hrTrabalhoFim: type: string format: date-time description: Hora Final de trabalho hrIntervaloIni: type: string format: date-time description: Hora Início do Intervalo de trabalho hrIntervaloFim: type: string format: date-time description: Hora Final do Intervalo de trabalho qtVeiculos: type: integer format: int64 description: inHoraTrabalho: type: integer format: int64 description: Tipo de Horário – Fixo ou Dinâmico – Se Fixo – vai utilizar o hrTrabalhoIni, hrTrabalhoFim, hrIntervaloIni, hrIntervaloFim – Se Dinâmico – qtTempoTrabalho, qtTempoIntervalo qtTempoTrabalho: type: string format: date-time description: Qtde Tempo de Trabalho qtTempoIntervalo: type: string format: date-time description: Qtde Tempo de Intervalo responses: 200: description: Ok schema: type: object required: – ok – dsErro – cdGrupoVeiculo properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: cdGrupoVeiculo: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/alteraVeiculo: post: description: Edição de Veículo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial – nrPlaca properties: nrCNPJFilial: type: string description: Código identificador da empresa cdGrupoVeiculo: type: integer format: int64 description: Código identificador do grupo do veículo nrPlaca: type: string description: Placa Veículo Chave primaria inSituacao: type: integer format: int64 description: Situação do Veículo dsRegiaoAtend: type: string description: Descrição da região de Atendimento dsVeiculo: type: string description: Descrição do veículo cdMotorista: type: integer format: int64 description: Motorista padrão deste veículo cdRastreadora: type: integer format: int64 description: cdVeiculoRastreadora: type: string description: retiraGrupoVeiculo: type: boolean description: Boolean indicando se deve retirar o grupo de veiculo responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/alteraSituacaoVeiculo: post: description: Alteração de Situação de Veículo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrPlaca – inSituacao properties: nrPlaca: type: string description: Placa Veículo Chave primaria inSituacao: type: integer format: int64 description: Situação do Veículo responses: 200: description: Ok schema: type: object required: – veiculoAlterado properties: veiculoAlterado: type: object allOf: – #/definitions/MCEVEIRec description: Informação do veículo alterado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/deletaVeiculo: post: description: Exclusão de Veículo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrPlaca properties: nrPlaca: type: string description: Placa Veículo cdGrupoVeiculo: type: integer format: int64 description: código do grupo de veículo responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/deletaGrupoVeiculo: post: description: Exclusão de Grupo de Veículo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdGrupoVeiculo properties: cdGrupoVeiculo: type: integer format: int64 description: Código identificador do Veículo nrCNPJFilial: type: string description: Código identificador da empresa responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/insereRestricao: post: description: Inserção do registro principal da restrição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – restricao properties: restricao: type: object allOf: – #/definitions/recRestricao description: Dados da restrição a ser inserida responses: 200: description: Ok schema: type: object required: – dsErro – ok – cdRestricao properties: dsErro: type: string description: Caso tenha ocorrido algum erro, a mensagem será retornada ok: type: boolean description: False em caso de erro cdRestricao: type: integer format: int64 description: Retorna o código da restrição gerada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/alteraRestricao: post: description: Alteração de uma restrição existente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – restricao properties: restricao: type: object allOf: – #/definitions/recRestricao description: Dados a serem alterados responses: 200: description: Ok schema: type: object properties: ok: type: boolean description: False em caso de erro default: true dsErro: type: string description: Mensagem de erro default: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/excluiRestricao: post: description: Exclusão da restrição e suas dependências tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRestricao properties: cdRestricao: type: integer format: int64 description: Código da restrição a ser excluída 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 /veiculos/actions/insereComposicaoRestricao: post: description: Inserção das regras de composição da restrição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – compRestricao properties: compRestricao: type: object allOf: – #/definitions/recComposicaoRestricao description: Dados da composição responses: 200: description: Ok schema: type: object required: – dsErro – ok – cdComposicao properties: dsErro: type: string description: Caso tenha ocorrido algum erro, a mensagem será retornada ok: type: boolean description: False em caso de erro cdComposicao: type: integer format: int64 description: Código da composição gerada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/alteraComposicaoRestricao: post: description: Atualização da composição de restrições tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – compRestricao properties: compRestricao: type: object allOf: – #/definitions/recComposicaoRestricao 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 /veiculos/actions/excluiComposicaoRestricao: post: description: Eclusão da composição da restrição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRestricao properties: cdRestricao: type: integer format: int64 description: Código da restrição cdComposicao: type: integer format: int64 description: Código da composição a ser excluída, quando não informada todas as composições da determinada restrição serão excluídas 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 /veiculos/actions/atualizaLocalizacaoVeiculo: post: description: Atualiza a localização do veículo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – localizacao properties: localizacao: type: object allOf: – #/definitions/localizacaoVeicRec description: Última localização do veículo 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 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 /veiculos/actions/insereVeiculoRastreadora: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrPlaca – cdRastreadora – cdVeiculoRastreadora properties: nrPlaca: type: string description: kmInicial: type: integer format: int64 description: kmAtual: type: integer format: int64 description: cdRastreadora: type: integer format: int64 description: cdVeiculoRastreadora: type: string description: dtUltPosicao: type: string format: date-time description: dsLatitude: type: string description: dsLongitude: 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/veiculoRastreadoraRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/insereRastreadora: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dsRastreadora – inAmbiente – inTpTecnologia – dsEndWebService – dsUsuario – dsSenha properties: dsRastreadora: type: string description: inAmbiente: type: integer format: int64 description: inTpTecnologia: type: integer format: int64 description: dsEndWebService: type: string description: dsUsuario: type: string description: dsSenha: type: string description: dsNomePlataforma: type: string description: Campo exclusivo para rastreadora Ranor responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: cdRastreadora: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/alteraRastreadora: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRastreadora – dsRastreadora – inAmbiente – inTpTecnologia – dsEndWebService – dsUsuario – dsSenha properties: cdRastreadora: type: integer format: int64 description: dsRastreadora: type: string description: inAmbiente: type: integer format: int64 description: inTpTecnologia: type: integer format: int64 description: dsEndWebService: type: string description: dsUsuario: type: string description: dsSenha: type: string description: dsNomePlataforma: type: string description: Campo exclusivo para rastreadora Ranor responses: 200: description: Ok schema: type: object required: – ok – dsErro – cdRastreadora properties: ok: type: boolean description: dsErro: type: string description: cdRastreadora: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/deletaRastreadora: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRastreadora properties: cdRastreadora: type: integer format: int64 description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/insereEngate: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrPlacaVeiculo – nrPlacaReboque – dtEngate properties: nrPlacaVeiculo: type: string description: nrPlacaReboque: type: string description: dtEngate: type: string format: date-time description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – cdEngate properties: ok: type: boolean description: dsErro: type: string description: cdEngate: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/alteraEngate: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdEngate – nrPlacaVeiculo – nrPlacaReboque – dtEngate properties: cdEngate: type: integer format: int64 description: nrPlacaVeiculo: type: string description: nrPlacaReboque: type: string description: dtEngate: type: string format: date-time description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – cdEngate properties: ok: type: boolean description: dsErro: type: string description: cdEngate: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /veiculos/actions/deletaEngate: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdEngate properties: cdEngate: type: integer format: int64 description: 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/genericErrordefinitions: IntegracaoRastreadoraAttrMap: description: Enums para mapeamento de informações provenientes do webserver da rastreadora para o objeto InserePosicaoVeiculoInput type: string enum: – NR_PLACA – DS_LATITUDE – DS_LONGITUDE – DS_RUA – DS_CIDADE – DS_UF – QT_VELOCIDADE – DT_POSICAO – DT_PACOTE – KM_POSICAO RVERASINFOTP: description: Tipo de informação sobre rastreadoras armazenada na entidade/tabela RVERASINFO type: string enum: – ONIXSAT_ULTIMO_ID – RANOR_BD serviceHealthStatus: description: Define o Status do serviço type: string enum: – UP – DOWN userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT MCEVEIRec: description: type: object required: – cdGrupoVeiculo – nrPlaca – inSituacao – dsSituacao – motorista properties: nrCNPJFilial: type: string description: cdGrupoVeiculo: type: integer format: int64 description: nrPlaca: type: string description: inSituacao: type: integer format: int64 description: dsSituacao: type: string description: dsRegiaoAtend: type: string description: dsVeiculo: type: string description: motorista: type: object allOf: – #/definitions/recMotorista description: dsLatitude: type: string description: dsLongitude: type: string description: hrAtualizacao: type: string format: date-time description: rastreadora: type: object allOf: – #/definitions/RVERASRec description: rastreadora do véiculo rvevei: type: object allOf: – #/definitions/veiculoRastreadoraRec description: mcegve: type: object allOf: – #/definitions/MCEGVERec description: filial: type: object allOf: – #/definitions/recFilial description: recMotorista: description: type: object required: – cdMotorista – dsNome – nrCpf properties: cdMotorista: type: integer format: int64 description: dsNome: type: string description: nrCpf: type: string description: recCodigoDescricaoGrupoVeiculo: description: type: object required: – codigo – descricao properties: codigo: type: integer format: int64 description: descricao: type: string description: MCEGVERec: description: type: object required: – cdGrupoVeiculo – dsGrupoVeiculo – hrTrabalhoIni – hrTrabalhoFim – hrIntervaloIni – hrIntervaloFim – veiculos – inHoraTrabalho properties: filiais: type: array items: type: string description: cdGrupoVeiculo: type: integer format: int64 description: dsGrupoVeiculo: type: string description: qtPeso: type: number format: double description: qtMetrosCubicos: type: number format: double description: inTpVeiculo: type: integer format: int64 description: inTpCarroceria: type: integer format: int64 description: qtCustoKm: type: number format: double description: qtCustoHora: type: number format: double description: qtCustoRota: type: number format: double description: qtEixos: type: integer format: int64 description: qtMinAtv: type: integer format: int64 description: qtOcupMinPeso: type: number format: double description: qtOcupMinMetragemCubica: type: number format: double description: inColeta: type: integer format: int64 description: inEntrega: type: integer format: int64 description: inServico: type: integer format: int64 description: hrTrabalhoIni: type: string format: date-time description: hrTrabalhoFim: type: string format: date-time description: hrIntervaloIni: type: string format: date-time description: hrIntervaloFim: type: string format: date-time description: qtVeiculos: type: integer format: int64 description: filial: type: object allOf: – #/definitions/recFilial description: veiculos: type: array items: type: object allOf: – #/definitions/MCEVEIRec minimum: 1 description: inHoraTrabalho: type: integer format: int64 description: Tipo de Horário – Fixo ou Dinâmico – Se Fixo – vai utilizar o hrTrabalhoIni, hrTrabalhoFim, hrIntervaloIni, hrIntervaloFim – Se Dinâmico – qtTempoTrabalho, qtTempoIntervalo qtTempoTrabalho: type: string format: date-time description: Qtde Tempo de Trabalho qtTempoIntervalo: type: string format: date-time description: Qtde Tempo de Intervalo inSitVeiculoRec: description: type: object required: – inSituacao – dsInSituacao properties: inSituacao: type: integer format: int64 description: dsInSituacao: type: string description: inCombustivelRec: description: type: object required: – inCombustivel – dsInCombustivel properties: inCombustivel: type: integer format: int64 description: dsInCombustivel: type: string description: 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: integer format: int64 description: nrTelefone: type: string description: dsLatitude: type: string description: dsLongitude: type: string description: recTipoVeiculo: description: type: object required: – inTpVeiculo – dsTpVeiculo properties: inTpVeiculo: type: integer format: int64 description: dsTpVeiculo: type: string description: recPlacaTipo: description: type: object required: – nrPlaca – inTpVeiculo properties: nrPlaca: type: string description: inTpVeiculo: type: integer format: int64 description: recTipoCarroceria: description: type: object required: – inTpCarroceria – dsTpCarroceria properties: inTpCarroceria: type: integer format: int64 description: dsTpCarroceria: type: string description: recComposicaoRestricao: description: Registro referente as composição da restrição por grupo e tipo de veículo, placa type: object required: – cdRestricao properties: cdRestricao: type: integer format: int64 description: Código da restrição cdSequencia: type: integer format: int64 description: Código sequêncial da composição inTpVeiculo: type: integer format: int64 description: Tipo do veículo cdGrupoVeiculo: type: integer format: int64 description: Código do grupo de veículo dadosGrupoVeiculo: type: object allOf: – #/definitions/MCEGVERec description: Demais informações referente ao grupo do veículo nrPlaca: type: string description: Número da placa de veículos dadosVeiculo: type: object allOf: – #/definitions/MCEVEIRec description: Demais informações do veículo, conforme número da placa nrFinalPlaca: type: string description: Número final da placa de veículos, apenas 1 caractere inTpCarroceria: type: integer format: int64 description: Tipo de carroceria 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 recRestricao: description: Registro referente as restrições por grupo e tipo de veículo, placa com faixa de horário e dias da semana discriminator: _discriminator type: object required: – _discriminator properties: cdRestricao: type: integer format: int64 description: Código da restrição dsRestricao: type: string description: Descrição da restrição inSegunda: type: integer format: int64 description: Segunda-feira inTerca: type: integer format: int64 description: Terça-feira inQuarta: type: integer format: int64 description: Quarta-feira inQuinta: type: integer format: int64 description: Quinta-feira inSexta: type: integer format: int64 description: Sexta-feira inSabado: type: integer format: int64 description: Sábado inDomingo: type: integer format: int64 description: Domingo inTpRestricao: type: integer format: int64 description: tipo de restrição: restringir=0 (padrão), exigir=1 dsTpRestricao: type: string description: descrição do restrição: restringir (padrão), exigir _discriminator: type: string description: recRestricaoCompleta: description: Registro completo da restrição e suas dependências allOf: – #/definitions/recRestricao – type: object properties: composicao: type: array items: type: object allOf: – #/definitions/recComposicaoRestricao description: Composições da restrição horarios: type: array items: type: object allOf: – #/definitions/recHorariosRestricao description: Faixas de horário da restrição localizacaoVeicRec: description: type: object required: – nrPlaca – hrAtualizacao – dsLatitude – dsLongitude properties: nrPlaca: type: string description: hrAtualizacao: type: string format: date-time description: dsLatitude: type: string description: dsLongitude: type: string description: recGrupoQtVeicEmUso: description: type: object required: – cdGrupoVeiculo – qtVeiculosEmUso properties: cdGrupoVeiculo: type: integer format: int64 description: qtVeiculosEmUso: type: integer format: int64 description: posicaoVeiculoRec: description: type: object required: – cdPosicao – nrPlaca – dsLatitude – dsLongitude – dsRua – dsCidade – dsUf properties: cdPosicao: type: integer format: int64 description: nrPlaca: type: string description: dsLatitude: type: string description: dsLongitude: type: string description: dsRua: type: string description: dsCidade: type: string description: dsUf: type: string description: qtVelocidade: type: integer format: int64 description: dtPosicao: type: string format: date-time description: dtPacote: type: string format: date-time description: kmPosicao: type: integer format: int64 description: veiculoRastreadoraRec: description: type: object required: – nrPlaca – kmInicial – kmAtual – cdRastreadora – cdVeiculoRastreadora – dtUltPosicao – dsLatitude – dsLongitude properties: nrPlaca: type: string description: kmInicial: type: integer format: int64 description: kmAtual: type: integer format: int64 description: cdRastreadora: type: integer format: int64 description: cdVeiculoRastreadora: type: string description: dtUltPosicao: type: string format: date-time description: dsLatitude: type: string description: dsLongitude: type: string description: integrarPosicoesVeiculosRec: description: type: object required: – posicao – veiculo – ok – dsErro properties: posicao: type: object allOf: – #/definitions/posicaoVeiculoRec description: veiculo: type: object allOf: – #/definitions/veiculoRastreadoraRec description: ok: type: boolean description: dsErro: type: string description: RVERASRec: description: type: object required: – cdRastreadora – dsRastreadora – inAmbiente – inTpTecnologia – dsEndWebService – dsUsuario – dsSenha properties: cdRastreadora: type: integer format: int64 description: dsRastreadora: type: string description: inAmbiente: type: integer format: int64 description: inTpTecnologia: type: integer format: int64 description: dsEndWebService: type: string description: dsUsuario: type: string description: dsSenha: type: string description: dsNomePlataforma: type: string description: Campos exclusivo para rastreadora Ranor MCEENGRec: description: type: object required: – cdEngate – nrPlacaVeiculo – nrPlacaReboque – dtEngate properties: cdEngate: type: integer format: int64 description: nrPlacaVeiculo: type: string description: nrPlacaReboque: type: string description: dtEngate: type: string format: date-time description: checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do healthcheck notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string 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