tmsentregas

roteirizacao

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

2.0info: 1.18.3 roteirizacao x-senior-domain: tmsentregas x-senior-domain-path: tmsentregas x-senior-service-path: roteirizacao contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/tmsentregassecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /roteirizacao/queries/roteirizar: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial – pontoPartida – pontoTermino – dtRoteirizacao – dtIniRoteiros – qtDiasRoteirizacao – atividades – inTpSelecaoVeic properties: nrCNPJFilial: type: string description: Filial da Roteirização pontoPartida: type: object allOf: – #/definitions/recOrigemDestino description: Local de saída do veículo. Normalmente são as coordenadas da filial do veículo/grupo do veículo pontoTermino: type: object allOf: – #/definitions/recOrigemDestino description: Local de saída do veículo. Normalmente são as coordenadas da filial do veículo/grupo do veículo dtRoteirizacao: type: string format: date-time description: Data e Hora em que o usuário iniciou o processamento da roteirização dtIniRoteiros: type: string format: date-time description: Data e Hora em que as rotas iniciarão qtDiasRoteirizacao: type: integer format: int64 description: Quantidade de dias previstos entre o início e término das rotas. qtTempoAtendPad: type: string format: date-time description: Tempo de atendimento padrão para as atividades que não tem o valor fornecido inFatorTrafego: type: integer format: int64 description: Fator de Tráfego. 0-Leve, 1-Moderado, 2-Intenso, 3-Congestionado atividades: type: array items: type: object allOf: – #/definitions/recAtividade minimum: 1 description: Atividades que serão roteirizadas inTpSelecaoVeic: type: integer format: int64 description: Tipo selecação para roteirização, se por placa ou por grupo de veículos. 0- Por Grupo de Veículo, 1- Por Veículo (Placa) veiculos: type: array items: type: object allOf: – #/definitions/recVeiculo description: Veículos que serão roteirizados gruposVeiculos: type: array items: type: object allOf: – #/definitions/recGrupoVeiculo description: Grupos de veículos que serão roteirizados. Informar a quantidade de veículos por grupo no campo qtVeiculos. diasNaoUteisViagem: type: array items: type: string format: date-time description: Dias não úteis entre a Data de Início das Rotas e Data Término das rotas (dtIniRoteiros + qtDiasRoteirizacao) inConsQtMinAtv: type: boolean description: Realizar cálculo de restrição quantidade mínima de atividade por rota. Padrão: false inConsOcupMinVeic: type: boolean description: Realizar cálculo de restrição ocupação mínima (peso) por rota. Padrão: false inRestricaoDestino: type: boolean description: Realizar cálculo de restrição para as atividades com destino vinculado. Padrão: false inRestricaoRegiao: type: boolean description: Realizar cálculo de restrição para as atividades com regiões vinculadas. Padrão: false inRestricaoOperacao: type: boolean description: Realizar cálculo de restrição por tipo de operação nas atividades com este valor fornecido. Padrão: false inRestricaoTpCarga: type: boolean description: Realizar cálculo de restrição por tipo de carga e cargas incompatíveis na rota. Padrão: false inRestricaoAgendamento: type: boolean description: Realizar cálculo de restrição por data de agendamento das atividades. Padrão: false inRestricaoViaPavimentada: type: boolean description: Considerar apenas vias com pavimentação. Padrão: false inConsDtAgendamento: type: boolean description: Considerar data agendamento cdRoteirizacao: type: integer format: int64 description: Para realizar reotomização de roteirização, informar o código da roteirização. Padrão: true cdRoteiro: type: integer format: int64 description: Para realizar a reotimização de uma rota específica, informar o código da roteirização E da rota. usuario: type: string description: E-mail do usuário da Senior X que será notificado ao término do processamento da roteirização. inModTransp: type: string allOf: – #/definitions/tipoModalidadeTransporte description: Fracionada=0 – Lotação=1. responses: 200: description: Ok schema: type: object required: – solucao – cdRoteirizacao – ok – dsErro properties: solucao: type: object allOf: – #/definitions/recRoteirizacao description: cdRoteirizacao: type: integer format: int64 description: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/queries/roteirizarManualmente: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial – roteiros – veiculos – qtDiasRoteirizacao – dtRoteirizacao properties: nrCNPJFilial: type: string description: roteiros: type: array items: type: object allOf: – #/definitions/recRoteiroManual minimum: 1 description: veiculos: type: array items: type: object allOf: – #/definitions/recVeiculo minimum: 1 description: qtDiasRoteirizacao: type: integer format: int64 description: diasNaoUteisViagem: type: array items: type: string format: date-time description: dtRoteirizacao: type: string format: date-time description: inFatorTrafego: type: integer format: int64 description: qtTempoAtendPad: type: string format: date-time description: inSituacao: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – solucao – cdRoteirizacao – ok – dsErro properties: solucao: type: object allOf: – #/definitions/recRoteirizacao description: cdRoteirizacao: type: integer format: int64 description: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/queries/roteirizarManualmenteAsync: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial – roteiros – veiculos – qtDiasRoteirizacao – dtRoteirizacao properties: nrCNPJFilial: type: string description: roteiros: type: array items: type: object allOf: – #/definitions/recRoteiroManual minimum: 1 description: veiculos: type: array items: type: object allOf: – #/definitions/recVeiculo minimum: 1 description: qtDiasRoteirizacao: type: integer format: int64 description: diasNaoUteisViagem: type: array items: type: string format: date-time description: dtRoteirizacao: type: string format: date-time description: inFatorTrafego: type: integer format: int64 description: qtTempoAtendPad: type: string format: date-time description: inSituacao: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – solucao – cdRoteirizacao – ok – dsErro properties: solucao: type: object allOf: – #/definitions/recRoteirizacao description: cdRoteirizacao: type: integer format: int64 description: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/queries/roteirizacaoExterna: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nrCNPJFilial – roteiros – veiculos – dtRoteirizacao properties: nrCNPJFilial: type: string description: roteiros: type: array items: type: object allOf: – #/definitions/recRoteiroExterno minimum: 1 description: veiculos: type: array items: type: object allOf: – #/definitions/recVeiculo minimum: 1 description: dtRoteirizacao: type: string format: date-time description: inSitRoteiros: type: integer format: int64 description: Situação em que os roteiros serão gerados. Padrão: 1 – Confirmado responses: 200: description: Ok schema: type: object required: – solucao – cdRoteirizacao – ok – dsErro properties: solucao: type: object allOf: – #/definitions/recRoteirizacao description: cdRoteirizacao: type: integer format: int64 description: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/queries/buscaListaRoteirizacao: post: description: Busca os registros de roteirização tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRoteirizacao: type: integer format: int64 description: Filtrar por código de roteirização dtRoteirizacao: type: string format: date-time description: Filtrar por data de roteirização cdRoteiro: type: integer format: int64 description: Filtrar por código da rota nrCNPJFilial: type: string description: Filtrar por CNPJ de Filiais, podendo uma lista separada por vírgula carregaDepOrfas: type: boolean description: Para retornar detalhes das atividades orfãs default: true carregaDepRoteiros: type: boolean description: Para retornar detalhes das rotas / roteiros default: true carregaDepVeiculos: type: boolean description: Para retornar detalhes dos veículos default: true detalhesFilialInfo: type: boolean description: Para retornar detalhes da filial default: true offset: type: integer format: int64 description: Página limit: type: integer format: int64 description: Qtde por página responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/recRoteirizacao minimum: 1 description: Lista resultante da consulta dsErro: type: string description: Erro eventual durante a consulta totalItens: type: integer format: int64 description: Total de itens para a paginação default: description: Error response schema: #/definitions/genericError get: description: Busca os registros de roteirização tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteirizacao description: Filtrar por código de roteirização in: query type: integer format: int64 – name: dtRoteirizacao description: Filtrar por data de roteirização in: query type: string format: date-time – name: cdRoteiro description: Filtrar por código da rota in: query type: integer format: int64 – name: nrCNPJFilial description: Filtrar por CNPJ de Filiais, podendo uma lista separada por vírgula in: query type: string – name: carregaDepOrfas description: Para retornar detalhes das atividades orfãs in: query type: boolean – name: carregaDepRoteiros description: Para retornar detalhes das rotas / roteiros in: query type: boolean – name: carregaDepVeiculos description: Para retornar detalhes dos veículos in: query type: boolean – name: detalhesFilialInfo description: Para retornar detalhes da filial in: query type: boolean – name: offset description: Página in: query type: integer format: int64 – name: limit description: Qtde por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/recRoteirizacao minimum: 1 description: Lista resultante da consulta dsErro: type: string description: Erro eventual durante a consulta totalItens: type: integer format: int64 description: Total de itens para a paginação default: description: Error response schema: #/definitions/genericError /roteirizacao/queries/buscaOrfas: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRoteirizacao: type: integer format: int64 description: cdAtividade: type: integer format: int64 description: carregaDepAtividades: type: boolean 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/recAtivOrfa minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteirizacao description: in: query type: integer format: int64 – name: cdAtividade description: in: query type: integer format: int64 – name: carregaDepAtividades description: in: query type: boolean 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/recAtivOrfa minimum: 1 description: default: description: Error response schema: #/definitions/genericError /roteirizacao/queries/buscaDirecoes: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – points properties: points: type: string description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – path properties: ok: type: boolean description: dsErro: type: string description: path: type: string description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: points description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – ok – dsErro – path properties: ok: type: boolean description: dsErro: type: string description: path: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/queries/confirmarRoteirizacao: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteirizacao properties: cdRoteirizacao: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – dsCalculoPedagio – roteirosAlterados – roteirosNaoAlterados – atividadesLiberadas properties: ok: type: boolean description: dsErro: type: string description: dsCalculoPedagio: type: string description: Retorno de informações sobre a execução do cálculo de pedágio roteirosAlterados: type: array items: type: object allOf: – #/definitions/recRoteiro minimum: 1 description: roteirosNaoAlterados: type: array items: type: object allOf: – #/definitions/recRoteiro minimum: 1 description: atividadesLiberadas: type: array items: type: object allOf: – #/definitions/recRoteiro minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteirizacao description: in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – dsCalculoPedagio – roteirosAlterados – roteirosNaoAlterados – atividadesLiberadas properties: ok: type: boolean description: dsErro: type: string description: dsCalculoPedagio: type: string description: Retorno de informações sobre a execução do cálculo de pedágio roteirosAlterados: type: array items: type: object allOf: – #/definitions/recRoteiro minimum: 1 description: roteirosNaoAlterados: type: array items: type: object allOf: – #/definitions/recRoteiro minimum: 1 description: atividadesLiberadas: type: array items: type: object allOf: – #/definitions/recRoteiro minimum: 1 description: default: description: Error response schema: #/definitions/genericError /roteirizacao/queries/reabrirRoteirizacao: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteirizacao properties: cdRoteirizacao: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – roteirosAlterados – roteirosNaoAlterados properties: ok: type: boolean description: dsErro: type: string description: roteirosAlterados: type: array items: type: object allOf: – #/definitions/recRoteiro minimum: 1 description: roteirosNaoAlterados: type: array items: type: object allOf: – #/definitions/recRoteiro minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteirizacao description: in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro – roteirosAlterados – roteirosNaoAlterados properties: ok: type: boolean description: dsErro: type: string description: roteirosAlterados: type: array items: type: object allOf: – #/definitions/recRoteiro minimum: 1 description: roteirosNaoAlterados: type: array items: type: object allOf: – #/definitions/recRoteiro minimum: 1 description: default: description: Error response schema: #/definitions/genericError /roteirizacao/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 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 default: description: Error response schema: #/definitions/genericError /roteirizacao/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /roteirizacao/actions/deletaRoteirizacao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteirizacao properties: cdRoteirizacao: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/actions/deletaAtvRoteiro: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade – cdRoteiro – cdRoteirizacao properties: cdAtividade: type: integer format: int64 description: cdRoteiro: type: integer format: int64 description: cdRoteirizacao: type: integer format: int64 description: bRoteiroEmExec: type: boolean description: Passar somente se for uma operação específica em roteiro já em execução usuario: type: string description: Usuario para receber notificacao da confirmação de leitura do motorista responses: 200: description: Ok schema: type: object required: – ok – dsErro – dsMensagemPush properties: ok: type: boolean description: dsErro: type: string description: dsMensagemPush: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/actions/moveAtividadeRota: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRotaDe – cdRotaPara – cdAtividade properties: cdRotaDe: type: integer format: int64 description: cdRotaPara: type: integer format: int64 description: cdAtividade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/actions/alteraSeqAtividadeRota: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteiro – cdAtividades properties: cdRoteiro: type: integer format: int64 description: cdAtividades: type: array items: type: integer format: int64 minimum: 1 description: bRoteiroEmExec: type: boolean description: Passar somente se for uma operação específica de alteração de sequência em roteiro já em execução responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/actions/adicionaAtividadesOrfas: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – atividades properties: atividades: type: array items: type: object allOf: – #/definitions/recAtivOrfa minimum: 1 description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/actions/moveAtividadeOrfaRota: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteirizacao – atividades properties: cdRoteirizacao: type: integer format: int64 description: atividades: type: array items: type: object allOf: – #/definitions/recVincRoteiro minimum: 1 description: bRoteiroEmExec: type: boolean description: usuario: type: string description: Usuario para receber notificacao da confirmação de leitura do motorista responses: 200: description: Ok schema: type: object required: – ok – dsErro – dsMensagemPush properties: ok: type: boolean description: dsErro: type: string description: dsMensagemPush: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/actions/retiraAtividadeOrfa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteirizacao – atividades properties: cdRoteirizacao: type: integer format: int64 description: atividades: type: array items: type: object allOf: – #/definitions/recAtividades minimum: 1 description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/actions/calculaTempoDistanciaRoteirizacao: post: description: Calcula os totais da roteirização, roteiros vinculados e recria as direções dos roteiros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteirizacao properties: cdRoteirizacao: type: integer format: int64 description: Código da roteirização responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/actions/removeRota: post: description: Remove rota da roteirizacao, adicionando atividades as orfas da roteirizacao tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteirizacao – cdRota – inRoteirizacao properties: cdRoteirizacao: type: integer format: int64 description: cdRota: type: integer format: int64 description: inRoteirizacao: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/actions/calculaPedagio: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteirizacao properties: cdRoteirizacao: type: integer format: int64 description: calcularRotasEmElaboracao: type: boolean description: default: true responses: 200: description: Ok schema: type: object required: – mensagem properties: mensagem: type: string description: default: description: Error response schema: #/definitions/genericError /roteirizacao/actions/atualizaDirecoes: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteiro properties: cdRoteiro: type: integer format: int64 description: gravarTodosOsPontos: type: boolean description: default: false responses: 200: description: Ok schema: type: object required: – direcoes properties: direcoes: type: array items: type: object allOf: – #/definitions/coordenadaRota minimum: 1 description: default: description: Error response schema: #/definitions/genericError /roteirizacao/actions/calculaPrevisaoAtendimentoRota: post: description: Calcula a previsão de atendimento da rota em execução baseado na localização do veículo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteiro properties: cdRoteiro: type: integer format: int64 description: Código das rota responses: 200: description: Ok schema: type: object required: – cdRoteiro – previsaoAtendimento properties: cdRoteiro: type: integer format: int64 description: previsaoAtendimento: type: array items: type: object allOf: – #/definitions/previsaoAtendimento minimum: 1 description: default: description: Error response schema: #/definitions/genericError /roteirizacao/actions/liberaAtividadesNaoRoteirizadas: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – atividadesLiberadas properties: atividadesLiberadas: type: array items: type: object allOf: – #/definitions/recAtividade minimum: 1 description: default: description: Error response schema: #/definitions/genericError definitions: statusComposicao: description: Status da composição type: string enum: – COMPOSICAO_NAO_OK – COMPOSICAO_OK statusRoteirizacaoLotacao: description: Status da roteirizacao tipo lotação type: string enum: – NAO_ROTEIRIZADA – EM_ELABORACAO tipoModalidadeTransporte: description: type: string enum: – FRACIONADA – LOTACAO 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 previsaoAtendimento: description: type: object required: – cdAtividade – dataPrevista properties: cdAtividade: type: integer format: int64 description: dataPrevista: type: string format: date-time description: recTempoDistancia: description: type: object required: – tempo – distancia properties: tempo: type: number format: double description: distancia: type: number format: double description: recDadosRotaSituacao: description: record para o evento situacoesRota type: object required: – inSituacao properties: cdRoteiro: type: integer format: int64 description: Código do Roteiro dsReferencia: type: string description: Documento de Referência qtKm: type: number format: double description: KM Estimado inSituacao: type: integer format: int64 description: Situação da Rota nrCNPJFilial: type: string description: CNPJ Filial da Rota nrCpfMotorista: type: string description: CPF do Motorista nrPlaca: type: string description: Placa do veículo atividades: type: array items: type: object allOf: – #/definitions/recDadosAtvSituacao description: informações da atividade recDadosAtvSituacao: description: record para o evento das atividades da situacoesRota type: object required: – cdAtividade properties: cdAtividade: type: integer format: int64 description: Código da Atividade dsNrDocto: type: string description: Número do Documento inDocto: type: integer format: int64 description: Tipo de Documento dtPrazoEntr: type: string format: date-time description: Data e hora do prazo de Atendimento da Atividade dtPrevEntr: type: string format: date-time description: Data e hora Previsão da atividade cdChaveAcesso: type: string description: recAtividade: description: type: object required: – cdAtividade – dsDestinatario – inAtividade – dsLocal properties: nrCNPJFilial: type: string description: cdAtividade: type: integer format: int64 description: cdDestino: type: string description: dsDestinatario: type: string description: inAtividade: type: integer format: int64 description: dsInAtividade: type: string description: dsLocal: type: string description: dsBairro: type: string description: dsCidade: type: string description: dsEstado: type: string description: dsPais: type: string description: cdNumero: type: integer format: int64 description: dsComplemento: type: string description: dsLat: type: number format: double description: dsLong: type: number format: double description: qtTempoAtend: type: string format: date-time description: dtJanelaIni: type: string format: date-time description: dtJanelaFim: type: string format: date-time description: qtPeso: type: number format: double description: qtVolumes: type: integer format: int64 description: qtMetrosCubicos: type: number format: double description: inPrioridade: type: integer format: int64 description: dsNrDocto: type: string description: dtPrazoEntr: type: string format: date-time description: dtPrevEntr: type: string format: date-time description: dtRealizado: type: string format: date-time description: cdTipoCarga: type: integer format: int64 description: tipoCarga: type: array items: type: object allOf: – #/definitions/recTipoCarga description: operacao: type: object allOf: – #/definitions/MCEOPERec description: restricoesRegiao: type: array items: type: object allOf: – #/definitions/recRestricaoCompleta description: restricoesOperacao: type: array items: type: object allOf: – #/definitions/recRestricaoCompleta description: restricoesTipoCarga: type: array items: type: object allOf: – #/definitions/recRestricaoCompleta description: diasUteisDestino: type: array items: type: object allOf: – #/definitions/recHorarioDestino description: restricoesDestino: type: array items: type: object allOf: – #/definitions/recRestricaoCompleta description: dtAgendamento: type: string format: date-time description: dtInclusao: type: string format: date-time description: dtPrevChegada: type: string format: date-time description: inDocto: type: integer format: int64 description: tipo de documento cdComposicao: type: integer format: int64 description: cdChaveAcesso: type: string description: dtUltimaPosicaoVeiculo: type: string format: date-time description: tempoAtraso: type: number format: double description: tempoRestante: type: number format: double description: MCEOPERec: description: type: object properties: cdOperacao: type: integer format: int64 description: cdReferencia: type: string description: dsOperacao: type: string description: filiais: type: array items: type: string description: recTipoCarga: description: type: object properties: cdTpCarga: type: integer format: int64 description: cdTpCargaIncomp: type: integer format: int64 description: cdSequencia: type: integer format: int64 description: dsTipoCarga: type: string description: incompativeis: type: array items: type: object allOf: – #/definitions/recTipoCarga 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 nrPlaca: type: string description: Número da placa de veículos nrPlaca2: type: string description: nrPlaca3: type: string description: nrPlaca4: type: string description: 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 _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 recMotorista: description: type: object required: – cdMotorista – dsNome – nrCpf properties: cdMotorista: type: integer format: int64 description: dsNome: type: string description: nrCpf: type: string description: recVeiculo: description: type: object required: – nrPlaca – filial properties: cdGrupoVeiculo: type: integer format: int64 description: cdGrupoVeiculoNrPlaca2: type: integer format: int64 description: nrCNPJFilial: type: string description: nrPlaca: type: string description: nrPlaca2: type: string description: nrPlaca3: type: string description: nrPlaca4: type: string description: dsRegiaoAtend: type: string description: grupo: type: object allOf: – #/definitions/recGrupoVeiculo description: motorista: type: object allOf: – #/definitions/recMotorista description: filial: type: object allOf: – #/definitions/recFilial 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: recGrupoVeiculo: description: type: object required: – cdGrupoVeiculo – dsGrupoVeiculo – qtPeso – qtMetrosCubicos – inHoraTrabalho properties: nrCNPJFilial: 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: qtCustoKm: type: number format: double description: qtCustoHora: type: number format: double description: qtCustoRota: 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: qtEixos: type: integer format: int64 description: qtMinAtv: type: integer format: int64 description: qtOcupMinPeso: type: number format: double description: qtOcupMinMetragemCubica: type: number format: double 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: 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 recDirections: description: type: object required: – paths – info properties: paths: type: array items: type: object allOf: – #/definitions/pathdto minimum: 1 description: info: type: object allOf: – #/definitions/infodto description: recFilial: description: type: object required: – dsLatitude – dsLongitude properties: cdEmpresa: type: integer format: int64 description: nrCNPJ: type: string description: dsFilial: type: string description: dsEndereco: type: string description: dsLatitude: type: number format: double description: dsLongitude: type: number format: double description: definicoes: type: object allOf: – #/definitions/MCEDEFRec description: recOrigemDestino: description: type: object required: – dsLatitude – dsLongitude properties: descricao: type: string description: dsLatitude: type: number format: double description: dsLongitude: type: number format: double description: MCEDEFRec: description: type: object properties: nrCNPJFilial: type: string description: inRoteirizacao: type: integer format: int64 description: qtTempoAtendPad: type: string format: date-time description: recRoteirizacao: description: type: object required: – cdRoteirizacao – dtRoteirizacao – qtRoteiros – qtPeso – qtVolumes – qtMetrosCubicos – qtAtividades – qtTempoEstimado – qtKm properties: cdRoteirizacao: type: integer format: int64 description: dtRoteirizacao: type: string format: date-time description: qtRoteiros: type: integer format: int64 description: qtPeso: type: number format: double description: qtVolumes: type: integer format: int64 description: qtMetrosCubicos: type: number format: double description: qtAtividades: type: integer format: int64 description: qtTempoEstimado: type: number format: double description: qtKm: type: number format: double description: trafego: type: object allOf: – #/definitions/recTrafego description: roteiros: type: array items: type: object allOf: – #/definitions/recRoteiro description: orfas: type: array items: type: object allOf: – #/definitions/recAtivOrfa description: veiculos: type: array items: type: object allOf: – #/definitions/recVeiculo description: gruposVeiculos: type: array items: type: object allOf: – #/definitions/recGrupoVeiculo description: qtDiasRoteirizacao: type: integer format: int64 description: dtIniRoteiros: type: string format: date-time description: qtTempoAtendPad: type: string format: date-time description: nrCNPJFilial: type: string description: filial: type: object allOf: – #/definitions/recFilial description: diasNaoUteisViagem: type: array items: type: object allOf: – #/definitions/recDia description: inConsOcupMinVeic: type: boolean description: inConsQtMinAtv: type: boolean description: inRestricaoDestino: type: boolean description: inRestricaoRegiao: type: boolean description: inRestricaoOperacao: type: boolean description: inRestricaoTpCarga: type: boolean description: inRestricaoViaPavimentada: type: boolean description: inRoteirizacao: type: integer format: int64 description: inTpSelecaoVeic: type: integer format: int64 description: qtCustoTotal: type: number format: double description: inModTransp: type: string allOf: – #/definitions/tipoModalidadeTransporte description: Fracionada=0 – Lotação=1. dsModTrasp: type: string description: Fracionada, Lotação vlPedagio: type: number format: double description: dtCalculoPedagio: type: string format: date-time description: recTrafego: description: type: object required: – inFatorTrafego properties: inFatorTrafego: type: integer format: int64 description: dsFatorTrafego: type: string description: recAtivOrfa: description: type: object required: – cdAtividade – cdRoteirizacao properties: cdAtividade: type: integer format: int64 description: cdRoteirizacao: type: integer format: int64 description: dsMotivo: type: string description: inDisponivel: type: integer format: int64 description: atividade: type: object allOf: – #/definitions/recAtividade description: recRoteiro: description: type: object required: – cdRoteiro – inSituacao – dsInSituacao – qtPeso – qtVolumes – qtMetrosCubicos – qtAtividades – cdRoteirizacao properties: nrCNPJFilial: type: string description: cdRoteiro: type: integer format: int64 description: dsReferencia: type: string description: nrPlaca: type: string description: nrPlaca2: type: string description: nrPlaca3: type: string description: nrPlaca4: type: string description: cdGrupoVeiculo: type: integer format: int64 description: motorista: type: object allOf: – #/definitions/recMotorista description: inSituacao: type: integer format: int64 description: dsInSituacao: type: string description: dtInicio: type: string format: date-time description: dtExecucao: type: string format: date-time description: dtPrevTermino: type: string format: date-time description: dtTermino: type: string format: date-time description: vinculacoes: type: array items: type: object allOf: – #/definitions/recVincRoteiro description: localIni: type: object allOf: – #/definitions/recLatLon description: localFim: type: object allOf: – #/definitions/recLatLon description: qtPeso: type: number format: double description: qtVolumes: type: integer format: int64 description: qtMetrosCubicos: type: number format: double description: qtAtividades: type: integer format: int64 description: qtTempoEstimado: type: number format: double description: qtKm: type: number format: double description: cdRoteirizacao: type: integer format: int64 description: inAlterado: type: integer format: int64 description: filial: type: object allOf: – #/definitions/recFilial description: veiculo: type: object allOf: – #/definitions/recVeiculo description: grupoVeiculo: type: object allOf: – #/definitions/recGrupoVeiculo 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: vlPedagio: type: number format: double description: dtCalculoPedagio: type: string format: date-time description: ocupacao: type: object allOf: – #/definitions/OcupacaoRec description: OcupacaoRec: description: Indicadores de ocupação do veículo na rota type: object required: – cdRoteiro properties: cdRoteiro: type: integer format: int64 description: cubagemMaxima: type: number format: double description: default: 0.0 cubagemOcupada: type: number format: double description: default: 0.0 cubagemRelativa: type: number format: double description: default: 0.0 pesoMaximo: type: number format: double description: default: 0.0 pesoOcupado: type: number format: double description: default: 0.0 pesoRelativo: type: number format: double description: default: 0.0 recRoteiroManual: description: type: object required: – nrCNPJFilial – nrPlaca properties: nrCNPJFilial: type: string description: nrPlaca: type: string description: nrPlaca2: type: string description: nrPlaca3: type: string description: nrPlaca4: type: string description: nrCpfMotorista: type: string description: dsReferencia: type: string description: dtInicio: type: string format: date-time description: atividades: type: array items: type: object allOf: – #/definitions/recAtividade 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: recRoteiroExterno: description: type: object required: – nrCNPJFilial – nrPlaca properties: nrCNPJFilial: type: string description: nrPlaca: type: string description: nrCpfMotorista: type: string description: dsReferencia: type: string description: dtInicio: type: string format: date-time description: atividades: type: array items: type: object allOf: – #/definitions/recAtividade description: recVincRoteiro: description: type: object required: – cdRoteiro – cdAtividade properties: cdRoteiro: type: integer format: int64 description: cdAtividade: type: integer format: int64 description: cdSequencia: type: integer format: int64 description: dtPrevChegada: type: string format: date-time description: dtPrevEntr: type: string format: date-time description: qtTempoEstimado: type: number format: double description: qtKm: type: number format: double description: inIncPosterior: type: integer format: int64 description: atividade: type: object allOf: – #/definitions/recAtividade description: recAtividades: description: type: object required: – cdAtividade properties: cdAtividade: type: integer format: int64 description: recLatLon: description: type: object required: – lat – lon properties: lat: type: number format: double description: lon: type: number format: double description: pathdto: description: type: object required: – distance – tempo – points – snapped_waypoints – bbox – points_encoded – instructions – coordinates properties: distance: type: number format: double description: tempo: type: number format: double description: points: type: string description: snapped_waypoints: type: string description: bbox: type: array items: type: number format: double minimum: 1 description: points_encoded: type: boolean description: instructions: type: array items: type: object allOf: – #/definitions/instructiondto minimum: 1 description: coordinates: type: array items: type: object allOf: – #/definitions/recLatLon minimum: 1 description: infodto: description: type: object required: – errors properties: errors: type: array items: type: object allOf: – #/definitions/errordto minimum: 1 description: errordto: description: type: object required: – details – message properties: details: type: string description: message: type: string description: instructiondto: description: type: object required: – distance – sign – interval – text – tempo properties: distance: type: number format: double description: sign: type: integer format: int64 description: interval: type: array items: type: integer format: int64 minimum: 1 description: text: type: string description: tempo: type: number format: double description: recHorarioDestino: description: Registro referente aos hor�rios e dias de semana �teis dos destinos type: object required: – cdDestino properties: cdDestino: type: string description: C�digo do destino cdSequencia: type: integer format: int64 description: C�digo sequencial da faixa de hor�rio inDiaSemana: type: integer format: int64 description: Dia da semana correspondente, come�ando a partir do Zero (Domingo) hrInicial: type: string format: date-time description: Hora inicial hrFinal: type: string format: date-time description: Hora final recRestricaoDestino: description: Vincula��o entre restri��es e destinos type: object required: – cdDestino – cdRestricao – dadosRestricao properties: cdDestino: type: string description: C�digo do destino cdRestricao: type: integer format: int64 description: C�digo da restri��o vinculada ao destino dadosRestricao: type: object allOf: – #/definitions/recRestricaoCompleta description: Dados da Restri��o recDia: description: Estrutura que possibilita a representação de uma lista de datas type: object properties: dia: type: string format: date-time description: coordenadaRota: description: type: object required: – sequencia – coordenada properties: sequencia: type: integer format: int64 description: coordenada: type: object allOf: – #/definitions/recLatLon 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

Este artigo foi útil para você?

Leave A Comment