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

roteiros

522 views 0 07/11/2018 Atualizado em 19/09/2024 integrador

2.0info: 4.4.3 roteiros description: Serviço Rotas/Roteiros x-senior-domain: tmsentregas x-senior-domain-path: tmsentregas x-senior-service-path: roteiros 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: /roteiros/queries/insereRoteiro: post: description: Cadastro de Roteiro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inSituacao properties: nrCNPJFilial: type: string description: Código identificador da empresa dsReferencia: type: string description: Referência da Roteiro nrPlaca: type: string description: Veículo nrPlaca2: type: string description: nrPlaca3: type: string description: nrPlaca4: type: string description: cdGrupoVeiculo: type: integer format: int64 description: Grupo do Veículo cpfMotorista: type: string description: Motorista inSituacao: type: integer format: int64 description: Status/Situação do Roteiro dtInicio: type: string format: date-time description: Data Início dtPrevTermino: type: string format: date-time description: Data de Término do Roteiro (calculado pelo roteirizador) vinculacoes: type: array items: type: object allOf: – #/definitions/MCEROTATRec description: Vinculações de atividades ao novo roteiro cdRoteirizacao: type: integer format: int64 description: Código da roteirização realizada qtPeso: type: number format: double description: Peso total do conteúdo do roteiro qtVolumes: type: integer format: int64 description: Quantidade de Volumes total do conteúdo do roteiro qtMetrosCubicos: type: number format: double description: Cubagem total do conteúdo do roteiro qtAtividades: type: integer format: int64 description: Quantidade de Atividades do roteiro qtTempoEstimado: type: number format: double description: Tempo Estimado para execução de todas as atividades do roteiro qtKm: type: number format: double description: Quilometragem total para execução de todas as atividades do roteiro 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: retornaParaOrigem: type: boolean description: Ao gerar rotas manualmente via integração, indica se o veículo vai retornar para a filial de origem após realizar a última atividade. Caso não informado será buscado das definições da filial. Valores: TRUE-volta para a filial de origem; FALSE-termina a rota na última atividade, não calculando tempo/quilometragem de retorno offset: type: integer format: int64 description: Página limit: type: integer format: int64 description: Qtde por página responses: 200: description: Ok schema: type: object required: – ok – dsErro – cdRoteiro properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: cdRoteiro: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaRoteiros: post: description: Busca as informações dos roteiros 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 idPontoApoio: type: integer format: int64 description: Identificador do ponto de apoio cdRoteiroIni: type: integer format: int64 description: Código identificador da Roteiro. Caso informado valor menor ou igual a zero, retorna todos. minimum: 0 cdRoteiroFim: type: integer format: int64 description: Código identificador da Roteiro range final minimum: 0 listaInSit: type: array items: type: integer format: int64 description: Filtro de Status do Roteiro. nrPlaca: type: string description: Placa do veículo. nrPlaca2: type: string description: Placa do veículo 2. nrPlaca3: type: string description: Placa do veículo 3. nrPlaca4: type: string description: Placa do veículo 4. dsReferencia: type: string description: Referência da Roteiro cdRoteirizacao: type: integer format: int64 description: Código da roteirização inBuscaDepAtividades: type: boolean description: Se deseja buscar os dados completos das atividades vinculadas. Padrão: true default: true inBuscaDepVincAtv: type: boolean description: Se não quer buscar as atividades vinculadas ao roteiro, enviar inBuscaDepAtividades= false e inBuscaDepVincAtv=false default: true inBuscaDepMotorista: type: boolean description: Se deseja buscar os dados completos do motorista vinculado ao roteiro. Padrão: true default: true cdMotorista: type: integer format: int64 description: Busca por motorista consisteRoteirizacao: type: boolean description: Consiste se existe roteirização vinculada dtIniRotas: type: string format: date-time description: Busca pela data das rotas dtAteIni: type: string format: date-time description: Busca pela data das rotas cdAtividade: type: integer format: int64 description: Busca pela atividade vinculada a rota dtPrevTermino: type: string format: date-time description: Busca pela data de previsão de término do roteiro listaCdRoteiro: type: array items: type: integer format: int64 description: Lista de códigos de roteiros 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 properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEROTRec minimum: 1 description: Lista das informações referente aos roteiros totalItens: type: integer format: int64 description: Total de itens para a paginação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as informações dos roteiros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: Código identificador da empresa in: query type: string – name: idPontoApoio description: Identificador do ponto de apoio in: query type: integer format: int64 – name: cdRoteiroIni description: Código identificador da Roteiro. Caso informado valor menor ou igual a zero, retorna todos. in: query type: integer format: int64 – name: cdRoteiroFim description: Código identificador da Roteiro range final in: query type: integer format: int64 – name: listaInSit description: Filtro de Status do Roteiro. in: query type: array items: type: integer format: int64 – name: nrPlaca description: Placa do veículo. in: query type: string – name: nrPlaca2 description: Placa do veículo 2. in: query type: string – name: nrPlaca3 description: Placa do veículo 3. in: query type: string – name: nrPlaca4 description: Placa do veículo 4. in: query type: string – name: dsReferencia description: Referência da Roteiro in: query type: string – name: cdRoteirizacao description: Código da roteirização in: query type: integer format: int64 – name: inBuscaDepAtividades description: Se deseja buscar os dados completos das atividades vinculadas. Padrão: true in: query type: boolean – name: inBuscaDepVincAtv description: Se não quer buscar as atividades vinculadas ao roteiro, enviar inBuscaDepAtividades= false e inBuscaDepVincAtv=false in: query type: boolean – name: inBuscaDepMotorista description: Se deseja buscar os dados completos do motorista vinculado ao roteiro. Padrão: true in: query type: boolean – name: cdMotorista description: Busca por motorista in: query type: integer format: int64 – name: consisteRoteirizacao description: Consiste se existe roteirização vinculada in: query type: boolean – name: dtIniRotas description: Busca pela data das rotas in: query type: string format: date-time – name: dtAteIni description: Busca pela data das rotas in: query type: string format: date-time – name: cdAtividade description: Busca pela atividade vinculada a rota in: query type: integer format: int64 – name: dtPrevTermino description: Busca pela data de previsão de término do roteiro in: query type: string format: date-time – name: listaCdRoteiro description: Lista de códigos de roteiros in: query type: array items: type: integer format: int64 – name: offset description: Página in: query type: integer format: int64 – name: limit description: Qtde por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEROTRec minimum: 1 description: Lista das informações referente aos roteiros totalItens: type: integer format: int64 description: Total de itens para a paginação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaRoteirosPorLote: post: description: Busca as informações dos roteiros por lote 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 listaCdAtividade: type: array items: type: integer format: int64 description: Lista de códigos de atividades. Limite de 100 códigos listaCdRoteiro: type: array items: type: integer format: int64 description: Lista de códigos de roteiros. Limite de 100 códigos desconsiderarRotNaoEntregue: type: boolean description: Desconsiderar roteiros onde a atividade possui movimentação de entrega não realizada default: false offset: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 minimum: 0 default: 0 limit: type: integer format: int64 description: Quantidade de registros por página minimum: 1 maximum: 100 default: 10 responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/recBuscaRoteirosPorLote minimum: 1 description: Lista das informações referente aos roteiros totalElements: type: integer format: int64 description: Quantidade total de registros encontrados totalPages: type: integer format: int64 description: Quantidade total de páginas encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as informações dos roteiros por lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: Código identificador da empresa in: query type: string – name: listaCdAtividade description: Lista de códigos de atividades. Limite de 100 códigos in: query type: array items: type: integer format: int64 – name: listaCdRoteiro description: Lista de códigos de roteiros. Limite de 100 códigos in: query type: array items: type: integer format: int64 – name: desconsiderarRotNaoEntregue description: Desconsiderar roteiros onde a atividade possui movimentação de entrega não realizada in: query type: boolean – name: offset description: O número da página retornado. A primeira página corresponde ao índice 0 in: query type: integer format: int64 – name: limit description: Quantidade de registros por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/recBuscaRoteirosPorLote minimum: 1 description: Lista das informações referente aos roteiros totalElements: type: integer format: int64 description: Quantidade total de registros encontrados totalPages: type: integer format: int64 description: Quantidade total de páginas encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/relatorioRoteiros: post: description: Gera um relatório de rotas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cnpjFilial: type: string description: CNPJ da filial codigoRota: type: integer format: int64 description: Código identificador da Rota statusRoteiro: type: integer format: int64 description: Código do Status do Roteiro dataInicio: type: string format: date-time description: Data de inicio que o relatório deve ser gerado dataFim: type: string format: date-time description: Data limite que o relatório deve ser gerado codigoRoteirizacao: type: integer format: int64 description: Código da Roteirização placa: type: string description: Placa do veículo codigoMotorista: type: integer format: int64 description: Código do Motorista responses: 200: description: Ok schema: type: object required: – urlRelatorio properties: urlRelatorio: type: string description: URL do relatório 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Gera um relatório de rotas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cnpjFilial description: CNPJ da filial in: query type: string – name: codigoRota description: Código identificador da Rota in: query type: integer format: int64 – name: statusRoteiro description: Código do Status do Roteiro in: query type: integer format: int64 – name: dataInicio description: Data de inicio que o relatório deve ser gerado in: query type: string format: date-time – name: dataFim description: Data limite que o relatório deve ser gerado in: query type: string format: date-time – name: codigoRoteirizacao description: Código da Roteirização in: query type: integer format: int64 – name: placa description: Placa do veículo in: query type: string – name: codigoMotorista description: Código do Motorista in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – urlRelatorio properties: urlRelatorio: type: string description: URL do relatório 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaStatusRoteiros: post: description: Pesquisa de Atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inSituacao properties: inSituacao: type: integer format: int64 description: Status da Roteiro. responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/inSitRoteiroRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Atividades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inSituacao description: Status da Roteiro. in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/inSitRoteiroRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/insereVinculacaoRoteiroAtividade: post: description: Cadastro de Vinculação entre Roteiro e Atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteiro – cdAtividade properties: cdRoteiro: type: integer format: int64 description: Código Identificador da Roteiro cdAtividade: type: integer format: int64 description: Código da Atividade cdSequencia: type: integer format: int64 description: Sequência de Execução da Atividade dtPrevEntr: type: string format: date-time description: Data de Previsão Término de Atendimento dtPrevChegada: type: string format: date-time description: Data de Previsão de Chegada ao Local do Atendimento qtTempoEstimado: type: number format: double description: Tempo estimado para chegada a partir do ponto anterior qtKm: type: number format: double description: Km estimada para chegada a partir do ponto anterior bRoteiroEmExec: type: boolean description: Passar somente se for uma operação específica de inclusão de atv em roteiro já em execução default: false atualizarDirecoes: type: boolean description: Definir como false para não atualizar (gerar) as direções da atividade vinculada a rota offset: type: integer format: int64 description: Página limit: type: integer format: int64 description: Qtde por página responses: 200: description: Ok schema: type: object required: – ok – dsErro 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 get: description: Cadastro de Vinculação entre Roteiro e Atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteiro description: Código Identificador da Roteiro in: query required: true type: integer format: int64 – name: cdAtividade description: Código da Atividade in: query required: true type: integer format: int64 – name: cdSequencia description: Sequência de Execução da Atividade in: query type: integer format: int64 – name: dtPrevEntr description: Data de Previsão Término de Atendimento in: query type: string format: date-time – name: dtPrevChegada description: Data de Previsão de Chegada ao Local do Atendimento in: query type: string format: date-time – name: qtTempoEstimado description: Tempo estimado para chegada a partir do ponto anterior in: query type: number format: double – name: qtKm description: Km estimada para chegada a partir do ponto anterior in: query type: number format: double – name: bRoteiroEmExec description: Passar somente se for uma operação específica de inclusão de atv em roteiro já em execução in: query type: boolean – name: atualizarDirecoes description: Definir como false para não atualizar (gerar) as direções da atividade vinculada a rota in: query type: boolean – name: offset description: Página in: query type: integer format: int64 – name: limit description: Qtde por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ok – dsErro 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 /roteiros/queries/buscaVinculacaoRoteiroAtividade: post: description: Pesquisa de Vinculação entre Roteiro e Atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdRoteiro: type: integer format: int64 description: Código Identificador da Roteiro. Se menor que zero retorna todas as Roteiros. cdAtividade: type: integer format: int64 description: Código da Atividade. Se menor que zero retorna todas as atividades. 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 properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEROTATRec minimum: 1 description: totalItens: type: integer format: int64 description: Total de itens para a paginação pagina: type: integer format: int64 description: Página atual itensPorPagina: type: integer format: int64 description: Quantidade de itens por página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Vinculação entre Roteiro e Atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteiro description: Código Identificador da Roteiro. Se menor que zero retorna todas as Roteiros. in: query type: integer format: int64 – name: cdAtividade description: Código da Atividade. Se menor que zero retorna todas as atividades. in: query type: integer format: int64 – name: offset description: Página in: query type: integer format: int64 – name: limit description: Qtde por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEROTATRec minimum: 1 description: totalItens: type: integer format: int64 description: Total de itens para a paginação pagina: type: integer format: int64 description: Página atual itensPorPagina: type: integer format: int64 description: Quantidade de itens por página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaAtividadesDisponiveis: post: description: Pesquisa de Vinculação entre Roteiro e Atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: nrCNPJFilial: type: string description: filiais: type: array items: type: string description: Lista com o CNPJ de filiais listaInAtividade: type: array items: type: integer format: int64 description: Tipo da Atividade. Ex: Coleta, Entrega. qtVolumesDe: type: integer format: int64 description: Quantidade de volumes referentes a atividade. Ex: Coleta de 2 volumes. qtVolumesAte: type: integer format: int64 description: qtPesoDe: type: number format: double description: Peso total dos volumes da atividade. Ex: 5.000,00 kg qtPesoAte: type: number format: double description: qtMetrosCubicosDe: type: number format: double description: Quantidade em metros cúbicos qtMetrosCubicosAte: type: number format: double description: inPrioridadeDe: type: integer format: int64 description: Prioridade: campo numérico inPrioridadeAte: type: integer format: int64 description: nrCepDe: type: integer format: int64 description: CEP do local da atividade nrCepAte: type: integer format: int64 description: dtPrazoEntrDe: type: string format: date-time description: Data do Prazo de Entrega dtPrazoEntrAte: type: string format: date-time description: dtJanelaDe: type: string format: date-time description: Janela de execução data e hora dtJanelaAte: type: string format: date-time description: listaRegioes: type: array items: type: integer format: int64 description: Filtro de Regiões. cdOperacao: type: integer format: int64 description: Filtro de Operação cdDestino: type: string description: Código do Destino dtInclusaoDe: type: string format: date-time description: Data e Hora inicial e final de inclusão das atividades dtInclusaoAte: type: string format: date-time description: inAgendamentoDia: type: integer format: int64 description: Para retornar atividades com agendamentos nos dias da roteirização ou sem agendamentos dtAgendamentos: type: array items: type: string format: date-time description: Dias dos agendamentos listaAtividades: type: array items: type: integer format: int64 description: Lista de Códigos de Atividade dtIniRoteiros: type: string format: date-time description: Data de início de roteiros dsNrDocto: type: string description: Número do embarcador cdEmbarcador: type: string description: código do embarcador inDocto: type: integer format: int64 description: código do documento cdTipoCarga: type: integer format: int64 description: código do tipo de carga inAtividade: type: integer format: int64 description: tipo da atividade ao buscar no passo 2 da roteirização atividadeNaoBloqueada: type: boolean description: Quando true, filtra por atividades não bloqueadas default: true idPontoApoio: type: integer format: int64 description: Identificador do ponto de apoio cdChaveAcesso: type: string description: Chave de acesso responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Vinculação entre Roteiro e Atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nrCNPJFilial description: in: query type: string – name: filiais description: Lista com o CNPJ de filiais in: query type: array items: type: string – name: listaInAtividade description: Tipo da Atividade. Ex: Coleta, Entrega. in: query type: array items: type: integer format: int64 – name: qtVolumesDe description: Quantidade de volumes referentes a atividade. Ex: Coleta de 2 volumes. in: query type: integer format: int64 – name: qtVolumesAte description: in: query type: integer format: int64 – name: qtPesoDe description: Peso total dos volumes da atividade. Ex: 5.000,00 kg in: query type: number format: double – name: qtPesoAte description: in: query type: number format: double – name: qtMetrosCubicosDe description: Quantidade em metros cúbicos in: query type: number format: double – name: qtMetrosCubicosAte description: in: query type: number format: double – name: inPrioridadeDe description: Prioridade: campo numérico in: query type: integer format: int64 – name: inPrioridadeAte description: in: query type: integer format: int64 – name: nrCepDe description: CEP do local da atividade in: query type: integer format: int64 – name: nrCepAte description: in: query type: integer format: int64 – name: dtPrazoEntrDe description: Data do Prazo de Entrega in: query type: string format: date-time – name: dtPrazoEntrAte description: in: query type: string format: date-time – name: dtJanelaDe description: Janela de execução data e hora in: query type: string format: date-time – name: dtJanelaAte description: in: query type: string format: date-time – name: listaRegioes description: Filtro de Regiões. in: query type: array items: type: integer format: int64 – name: cdOperacao description: Filtro de Operação in: query type: integer format: int64 – name: cdDestino description: Código do Destino in: query type: string – name: dtInclusaoDe description: Data e Hora inicial e final de inclusão das atividades in: query type: string format: date-time – name: dtInclusaoAte description: in: query type: string format: date-time – name: inAgendamentoDia description: Para retornar atividades com agendamentos nos dias da roteirização ou sem agendamentos in: query type: integer format: int64 – name: dtAgendamentos description: Dias dos agendamentos in: query type: array items: type: string format: date-time – name: listaAtividades description: Lista de Códigos de Atividade in: query type: array items: type: integer format: int64 – name: dtIniRoteiros description: Data de início de roteiros in: query type: string format: date-time – name: dsNrDocto description: Número do embarcador in: query type: string – name: cdEmbarcador description: código do embarcador in: query type: string – name: inDocto description: código do documento in: query type: integer format: int64 – name: cdTipoCarga description: código do tipo de carga in: query type: integer format: int64 – name: inAtividade description: tipo da atividade ao buscar no passo 2 da roteirização in: query type: integer format: int64 – name: atividadeNaoBloqueada description: Quando true, filtra por atividades não bloqueadas in: query type: boolean – name: idPontoApoio description: Identificador do ponto de apoio in: query type: integer format: int64 – name: cdChaveAcesso description: Chave de acesso in: query type: string responses: 200: description: Ok schema: type: object required: – listaResultado – dsErro properties: listaResultado: type: array items: type: object allOf: – #/definitions/MCEATVRec minimum: 1 description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaTotaisAtividadesDisponiveis: post: description: Pesquisa de Vinculação entre Roteiro e Atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filiais: type: array items: type: string description: Lista com o CNPJ de filiais responses: 200: description: Ok schema: type: object required: – resultado – dsErro properties: resultado: type: object allOf: – #/definitions/TotaisAtividadesDisponiveis description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa de Vinculação entre Roteiro e Atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filiais description: Lista com o CNPJ de filiais in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – resultado – dsErro properties: resultado: type: object allOf: – #/definitions/TotaisAtividadesDisponiveis description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaPais: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdIbge: type: string description: dsNome: type: string description: dsSigla: type: string description: limit: type: integer format: int64 description: default: 0 offset: type: integer format: int64 description: default: 0 responses: 200: description: Ok schema: type: object required: – resultado – pageInfo properties: resultado: type: array items: type: object allOf: – #/definitions/PaisRec minimum: 1 description: pageInfo: type: object allOf: – #/definitions/PageInfo description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdIbge description: in: query type: string – name: dsNome description: in: query type: string – name: dsSigla description: in: query type: string – name: limit description: in: query type: integer format: int64 – name: offset description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – resultado – pageInfo properties: resultado: type: array items: type: object allOf: – #/definitions/PaisRec minimum: 1 description: pageInfo: type: object allOf: – #/definitions/PageInfo description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaEstado: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdIbge: type: string description: dsNome: type: string description: dsSigla: type: string description: limit: type: integer format: int64 description: default: 0 offset: type: integer format: int64 description: default: 0 responses: 200: description: Ok schema: type: object required: – resultado – pageInfo properties: resultado: type: array items: type: object allOf: – #/definitions/EstadoRec minimum: 1 description: pageInfo: type: object allOf: – #/definitions/PageInfo description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdIbge description: in: query type: string – name: dsNome description: in: query type: string – name: dsSigla description: in: query type: string – name: limit description: in: query type: integer format: int64 – name: offset description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – resultado – pageInfo properties: resultado: type: array items: type: object allOf: – #/definitions/EstadoRec minimum: 1 description: pageInfo: type: object allOf: – #/definitions/PageInfo description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaEstadoPorSigla: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – sigla properties: sigla: type: string description: responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: object allOf: – #/definitions/EstadoRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: sigla description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: object allOf: – #/definitions/EstadoRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaCidade: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cdIbge: type: string description: dsNome: type: string description: dsCep: type: string description: dsSiglaEstado: type: string description: limit: type: integer format: int64 description: default: 0 offset: type: integer format: int64 description: default: 0 responses: 200: description: Ok schema: type: object required: – resultado – pageInfo properties: resultado: type: array items: type: object allOf: – #/definitions/CidadeRec minimum: 1 description: pageInfo: type: object allOf: – #/definitions/PageInfo description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdIbge description: in: query type: string – name: dsNome description: in: query type: string – name: dsCep description: in: query type: string – name: dsSiglaEstado description: in: query type: string – name: limit description: in: query type: integer format: int64 – name: offset description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – resultado – pageInfo properties: resultado: type: array items: type: object allOf: – #/definitions/CidadeRec minimum: 1 description: pageInfo: type: object allOf: – #/definitions/PageInfo description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaCidadePorCep: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cep properties: cep: type: string description: responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: object allOf: – #/definitions/CidadeRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cep description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: object allOf: – #/definitions/CidadeRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaTipoAutenticacaoOperadoraPedagio: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operadora properties: operadora: type: string description: responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: operadora description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/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 /roteiros/queries/buscaCoordenadasRota: post: description: Retorna os registros da tabela ROTDIRPT relativos ao roteiro informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteiro properties: cdRoteiro: type: integer format: int64 description: Código da rota cdAtividade: type: integer format: int64 description: Código da atividade responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os registros da tabela ROTDIRPT relativos ao roteiro informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteiro description: Código da rota in: query required: true type: integer format: int64 – name: cdAtividade description: Código da atividade in: query type: integer format: int64 responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaTrajetoPlanejado: post: description: Retorna as coordenadas de acordo com o roteiro e/ou atividade informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteiro properties: cdRoteiro: type: integer format: int64 description: Código da rota cdAtividade: type: integer format: int64 description: Código da atividade responses: 200: description: Ok schema: type: object required: – coordenadas properties: coordenadas: type: array items: type: object allOf: – #/definitions/LatLonRec minimum: 1 description: Lista de coordenadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as coordenadas de acordo com o roteiro e/ou atividade informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteiro description: Código da rota in: query required: true type: integer format: int64 – name: cdAtividade description: Código da atividade in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – coordenadas properties: coordenadas: type: array items: type: object allOf: – #/definitions/LatLonRec minimum: 1 description: Lista de coordenadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaMotoristasRotasEmExecucao: post: description: Retorna os motoristas que estão vinculados a Rotas em Execução tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filiais properties: filiais: type: array items: type: string minimum: 1 description: Lista de CNPJ de filiais responses: 200: description: Ok schema: type: object required: – motoristas properties: motoristas: type: array items: type: object allOf: – #/definitions/recMotorista minimum: 1 description: Lista com o resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os motoristas que estão vinculados a Rotas em Execução tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filiais description: Lista de CNPJ de filiais in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – motoristas properties: motoristas: type: array items: type: object allOf: – #/definitions/recMotorista minimum: 1 description: Lista com o resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaPlacasRotasEmExecucao: post: description: Retorna os veículos que estão vinculados a Rotas em Execução tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filiais properties: filiais: type: array items: type: string minimum: 1 description: Lista de CNPJ de filiais responses: 200: description: Ok schema: type: object required: – placas properties: placas: type: array items: type: string minimum: 1 description: Lista com o resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os veículos que estão vinculados a Rotas em Execução tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filiais description: Lista de CNPJ de filiais in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – placas properties: placas: type: array items: type: string minimum: 1 description: Lista com o resultado da busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaRotasFixas: post: description: Primitiva para buscar as rotas fixas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: idRotaFixa: type: integer format: int64 description: Identificador da Rota Fixa nrCNPJFilial: type: string description: CNPJ da filial dsDescricao: type: string description: Descrição da Rota Fixa inStatus: type: boolean description: Status da Rota Fixa offset: type: integer format: int64 description: Página limit: type: integer format: int64 description: Quantidade por página ordenacao: type: string allOf: – #/definitions/ordenacao description: Ordem Ex.: ASC,DESC campoOrdenacao: type: string allOf: – #/definitions/campoOrdenacao description: Campo de Ordenação Ex.: idRotaFixa responses: 200: description: Ok schema: type: object required: – rotasFixas properties: rotasFixas: type: array items: type: object allOf: – #/definitions/rotaFixaRec minimum: 1 description: Rotas fixas encontradas totalItens: type: integer format: int64 description: Total de itens para a paginação pagina: type: integer format: int64 description: Página atual itensPorPagina: type: integer format: int64 description: Quantidade de itens por página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/queries/buscaRotaPlaca: post: description: Primitiva para identificar a situação da rota atual da placa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – placas properties: placas: type: array items: type: string minimum: 1 description: Informar lista com placas. Ex.: [AAA1234,AAA1111] responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/recDadosSituacaoRota minimum: 1 description: Lista com o resultado das placas informadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para identificar a situação da rota atual da placa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: placas description: Informar lista com placas. Ex.: [AAA1234,AAA1111] in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/recDadosSituacaoRota minimum: 1 description: Lista com o resultado das placas informadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/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 /roteiros/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 /roteiros/actions/alteraRoteiro: post: description: Edição de Roteiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteiro properties: nrCNPJFilial: type: string description: Código identificador da empresa cdRoteiro: type: integer format: int64 description: Código Identificador do Roteiro dsReferencia: type: string description: Referência do Roteiro nrPlaca: type: string description: Veículo nrPlaca2: type: string description: nrPlaca3: type: string description: nrPlaca4: type: string description: cdGrupoVeiculo: type: integer format: int64 description: Grupo de Veículo cpfMotorista: type: string description: Motorista inSituacao: type: integer format: int64 description: Status/Situação do Roteiro dtInicio: type: string format: date-time description: Data Início dtPrevTermino: type: string format: date-time description: Data de Término do Roteiro (calculado pelo roteirizador) cdRoteirizacao: type: integer format: int64 description: Código da roteirização realizada inAlterado: type: integer format: int64 description: Status indicando se o roteiro foi alterado manualmente qtPeso: type: number format: double description: Peso total do conteúdo do roteiro qtVolumes: type: integer format: int64 description: Quantidade de Volumes total do conteúdo do roteiro qtMetrosCubicos: type: number format: double description: Cubagem total do conteúdo do roteiro qtAtividades: type: integer format: int64 description: Quantidade de Atividades do roteiro qtTempoEstimado: type: number format: double description: Tempo Estimado para execução de todas as atividades do roteiro qtKm: type: number format: double description: Quilometragem total para execução de todas as atividades do roteiro vinculacoes: type: array items: type: object allOf: – #/definitions/MCEROTATRec description: Vinculações de atividades que pertencem ao roteiro e que necessitam de atualização 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: custo: type: number format: double description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – recalcularTemposDistancias properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: recalcularTemposDistancias: type: boolean description: Indicativo se alteracao necessita que os tempos e distancias sejam recalculados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/vinculaMotorista: post: description: Vinculacao de Motorista ao Roteiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteiro – cpfMotorista properties: cdRoteiro: type: integer format: int64 description: cpfMotorista: type: string description: Motorista 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 /roteiros/actions/vinculaVeiculo: post: description: Vinculacao de Motorista ao Roteiro 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: nrPlaca: type: string description: Motorista nrPlaca2: type: string description: nrPlaca3: type: string description: nrPlaca4: type: string description: grupoVeiculoObrigatorio: type: boolean description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – dsSucesso properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: String com mensagem de erro da operação dsSucesso: type: string description: String com mensagem de sucesso na operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/deletaRoteiro: post: description: Exclusão de Roteiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteirizacao properties: cdRoteiro: type: integer format: int64 description: Código identificador da Rota cdRoteirizacao: type: integer format: int64 description: Código da roteirização inRoteirizacao: type: integer format: int64 description: Tipo da roteirização responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: String com mensagem de erro da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/deletaVinculacaoRoteiroAtividade: post: description: Exclusão de Vinculação entre Roteiro e Atividade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdRoteiro – cdAtividade properties: cdRoteiro: type: integer format: int64 description: Código Identificador da Roteiro cdAtividade: type: integer format: int64 description: Código da Atividade bRoteiroEmExec: type: boolean description: Passar somente se for uma operação específica em roteiro já em execução 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 /roteiros/actions/alteraSeqAtividadeRota: post: description: Altera a sequencia da atividade na rota 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: Roteiro ao qual pertencem as atividades cdAtividades: type: array items: type: integer format: int64 minimum: 1 description: Códigos das atividades na nova sequência 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 default: false 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 /roteiros/actions/alteraSituacaoRoteiro: post: description: Altera Situação dos Roteiros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inSituacao properties: cdRoteiro: type: array items: type: integer format: int64 description: Código Identificador dos roteiros cdRoteirizacao: type: array items: type: integer format: int64 description: Código Identificador das roteirizações dos roteiros inSituacao: type: integer format: int64 description: Situação que os roteiros possuirão responses: 200: description: Ok schema: type: object required: – ok – dsErro – dsCalculoPedagio – roteirosAlterados – roteirosNaoAlterados properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso 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/MCEROTRec minimum: 1 description: roteirosNaoAlterados: type: array items: type: object allOf: – #/definitions/MCEROTRec minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/executarRoteiro: post: description: Executar Roteiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: roteiros: type: array items: type: integer format: int64 description: Lista de roteiros cdRoteirizacao: type: integer format: int64 description: Roteirizacao responses: 200: description: Ok schema: type: object required: – ok – dsErro – roteirosExecutados properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: roteirosExecutados: type: array items: type: object allOf: – #/definitions/MCEROTRec minimum: 1 description: Lista de roteiros executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/executarRoteiroAutomaticamente: post: description: Executar Roteiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/finalizarRoteiro: post: description: Executar Roteiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roteiros properties: roteiros: type: array items: type: integer format: int64 minimum: 1 description: Lista com os códigos dos roteiros a finalizar permiteFinRotSemOcorr: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – ok – dsErro – roteirosFinalizados – roteirosNaoFinalizados properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: roteirosFinalizados: type: array items: type: object allOf: – #/definitions/MCEROTRec minimum: 1 description: Lista de roteiros finalizados roteirosNaoFinalizados: type: array items: type: object allOf: – #/definitions/MCEROTRec minimum: 1 description: Lista de roteiros não finalizados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/finalizarRoteiroAutomaticamente: post: description: Finalizar Roteiro Automaticamente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/roteiroAlterado: post: description: Marca o roteiro como alterado manualmente 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: 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 /roteiros/actions/insereAgendamentosPadroesRoteiro: post: description: Adiciona os agendamentos padrões do roteiros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: dsErro: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/inserePais: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pais properties: pais: type: object allOf: – #/definitions/PaisRec description: responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: object allOf: – #/definitions/PaisRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/alteraPais: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pais properties: pais: type: object allOf: – #/definitions/PaisRec description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/deletaPais: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdIbge properties: cdIbge: type: string description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/insereEstado: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – estado properties: estado: type: object allOf: – #/definitions/EstadoRec description: responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: object allOf: – #/definitions/EstadoRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/alteraEstado: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – estado properties: estado: type: object allOf: – #/definitions/EstadoRec description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/deletaEstado: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdIbge properties: cdIbge: type: string description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/insereCidade: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cidade properties: cidade: type: object allOf: – #/definitions/CidadeRec description: responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: object allOf: – #/definitions/CidadeRec description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/alteraCidade: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cidade properties: cidade: type: object allOf: – #/definitions/CidadeRec description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/deletaCidade: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdIbge properties: cdIbge: type: string description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/calculaPedagio: 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: responses: 200: description: Ok schema: type: object required: – mensagem properties: mensagem: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/insereRotaFixa: post: description: Primitiva para cadastro de rotas fixas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – rotaFixa properties: rotaFixa: type: object allOf: – #/definitions/rotaFixaRec description: Informações para o cadastro da rota fixa responses: 200: description: Ok schema: type: object required: – rotaFixa properties: rotaFixa: type: object allOf: – #/definitions/rotaFixaRec description: Informações da rota fixa cadastrada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/alteraRotaFixa: post: description: Primitiva para alteração de rotas fixas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – rotaFixa properties: rotaFixa: type: object allOf: – #/definitions/rotaFixaRec description: Informações para a alteração da rota fixa responses: 200: description: Ok schema: type: object required: – rotaFixa properties: rotaFixa: type: object allOf: – #/definitions/rotaFixaRec description: Informações da rota fixa alterada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/actions/deletaRotaFixa: post: description: Primitiva para deletar rota fixa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idRotaFixa properties: idRotaFixa: type: integer format: int64 description: Código identificador da rota fixa a ser deletada responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /roteiros/events/coordenadasSobDemanda: post: description: Envia coordenadas de forma páginada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – cdRoteiro – coordenadas – paginaAtual – totalDePaginas properties: cdRoteiro: type: integer format: int64 description: Código da rota coordenadas: type: array items: type: object allOf: – #/definitions/LatLonRec minimum: 1 description: Lista de coordenadas paginaAtual: type: integer format: int64 description: Número da página retornada pela busca totalDePaginas: type: integer format: int64 description: Número total de páginas que serão retornadas responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /roteiros/events/roteirosExecutados: post: description: Informa que houve execução de roteiros x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – roteirosExecutados – roteirosNaoExecutados – ok – dsErro properties: roteirosExecutados: type: array items: type: object allOf: – #/definitions/MCEROTRec minimum: 1 description: roteirosNaoExecutados: type: array items: type: object allOf: – #/definitions/MCEROTRec minimum: 1 description: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /roteiros/events/roteirosFinalizados: post: description: Informa que houve finalização de roteiros x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – roteirosFinalizados – roteirosNaoFinalizados – ok – dsErro properties: roteirosFinalizados: type: array items: type: object allOf: – #/definitions/MCEROTRec minimum: 1 description: roteirosNaoFinalizados: type: array items: type: object allOf: – #/definitions/MCEROTRec minimum: 1 description: ok: type: boolean description: Bolean indicando se a operação teve sucesso dsErro: type: string description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /roteiros/events/situacoesRota: post: description: Informa todas as situações das rotas x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ok – dsErro – ws_users properties: rotas: type: array items: type: object allOf: – #/definitions/recDadosRotaSituacao description: Rotas ok: type: boolean description: Boolean indicando se a operação teve sucesso dsErro: type: string description: log de erro ws_users: type: string description: Usuários que receberão a chamada – websocket responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /roteiros/events/situacaoRoteiroAlterada: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – roteiroAlterado – ok – dsErro properties: roteiroAlterado: type: object allOf: – #/definitions/MCEROTRec description: ok: type: boolean description: Indicador de sucesso da operação dsErro: type: string description: Descrição do erro ocorrido. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /roteiros/events/vinculacaoAtividadeRota: post: description: Informa quando uma atividade for vinculada/desvinculada a uma determinada rota x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – cdRota – situacaoRota – nrCNPJFilial – ws_users properties: cdAtividade: type: integer format: int64 description: Código da atividade cdRota: type: integer format: int64 description: Código da Rota situacaoRota: type: integer format: int64 description: Situação da Rota nrCNPJFilial: type: string description: CNPJ da filial inclusao: type: boolean description: Quando true, indica que a atividade foi vinculada a rota default: true ws_users: type: string description: Usuários que receberão a chamada – websocket responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /roteiros/events/sequenciaAtividadeAlteradaRota: post: description: Informa quando a sequência de uma atividade foi alterada dentro de uma rota x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – cdRota – listaAtividades properties: cdRota: type: integer format: int64 description: Código da rota listaAtividades: type: array items: type: object allOf: – #/definitions/MCEROTATRec minimum: 1 description: Código da atividade responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: TipoAmbiente: description: Tipo de ambiente para integrações via webservices type: string enum: – HOMOLOGACAO – PRODUCAO 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 ordenacao: description: Direção da ordenação type: string enum: – ASC – DESC campoOrdenacao: description: Campo para ordenação type: string enum: – idRotaFixa – nrCNPJFilial serviceHealthStatus: description: Define o Status do serviço type: string enum: – UP – DOWN situacaoAtividade: description: Tipo de Situação type: string enum: – EM_ABERTO – EM_ANALISE – EM_ANDAMENTO – BLOQUEADA – ORFA – FINALIZADA userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT recDadosSituacaoRota: description: record para dados da situação da rota type: object required: – situacao – rota – placa properties: situacao: type: object allOf: – #/definitions/inSitRoteiroRec description: Situação da Rota rota: type: integer format: int64 description: Código da Rota placa: type: string description: Placa veículo recDadosRotaSituacao: description: record para o evento situacoesRota type: object required: – cdRoteiro – dtInicio – inSituacao – nrCNPJFilial properties: cdRoteiro: type: integer format: int64 description: Código do Roteiro dtInicio: type: string format: date-time description: Data de início 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 inRoteirizacao: type: integer format: int64 description: Tipo da roteirização 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: MCEROTRec: description: type: object required: – inSituacao 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: inSituacao: type: integer format: int64 description: dsInSituacao: type: string description: dtInicio: type: string format: date-time description: dtTermino: type: string format: date-time description: roteirizacao: type: object allOf: – #/definitions/recRoteirizacao description: vinculacoes: type: array items: type: object allOf: – #/definitions/MCEROTATRec 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: inAlterado: type: integer format: int64 description: motorista: type: object allOf: – #/definitions/recMotorista description: dtPrevTermino: type: string format: date-time description: cdGrupoVeiculo: 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: dtExecucao: type: string format: date-time description: inAlteradoEmExecucao: type: integer format: int64 description: atividades: type: array items: type: object allOf: – #/definitions/MCEATVRec description: informações da atividade vlPedagio: type: number format: double description: dtCalculoPedagio: type: string format: date-time description: ocupacao: type: object allOf: – #/definitions/OcupacaoRec description: retornaParaOrigem: type: boolean description: usuarioFinalizacao: type: string description: finalizacaoViaAgendamento: type: boolean description: custo: type: number format: double description: recMotorista: description: Dados referente ao motorista type: object required: – cdMotorista – dsNome – nrCpf – cdUsuario – nrRg properties: cdMotorista: type: integer format: int64 description: Código do motorista dsNome: type: string description: Nome do motorista nrCpf: type: string description: CPF cdUsuario: type: string description: Código do usuário nrRg: type: string description: RG recRoteirizacao: description: type: object properties: cdRoteirizacao: type: integer format: int64 description: inRoteirizacao: type: integer format: int64 description: MCEROTATRec: description: type: object required: – cdAtividade – cdSequencia 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: dtPrevEntrAtualizada: type: string format: date-time description: Caso a atividade esteja em uma rota em execução, retorna a data de previsão atualizada referente a posição do veículo até a atividade qtTempoEstimado: type: number format: double description: qtKm: type: number format: double description: inIncPosterior: type: integer format: int64 description: atividade: type: object allOf: – #/definitions/MCEATVRec description: grauPrecisao: type: string description: Grau Precisão inSitRoteiroRec: description: record situação da rota 0-Em Elaboração | 1-Confirmado | 2-Em Execução | 3-Finalizado type: object required: – inSituacao – dsInSituacao properties: inSituacao: type: integer format: int64 description: Código da situação dsInSituacao: type: string description: Descrição da situação TotaisAtividadesDisponiveis: description: type: object required: – atividades – volumeTotal – pesoTotal properties: atividades: type: integer format: int64 description: volumeTotal: type: integer format: int64 description: pesoTotal: type: number format: double description: MCEATVRec: description: type: object required: – cdAtividade – inAtividade properties: nrCNPJFilial: type: string description: cdAtividade: type: integer format: int64 description: inAtividade: type: integer format: int64 description: dsInAtividade: type: string description: inPrioridade: type: integer format: int64 description: dsNrDocto: type: string description: dsLocal: type: string description: cdDestino: type: string description: dsDestinatario: type: string description: qtVolumes: type: integer format: int64 description: qtPeso: type: number format: double description: qtMetrosCubicos: type: number format: double description: dtPrazoEntr: type: string format: date-time description: dtRealizado: type: string format: date-time description: dtPrevEntr: type: string format: date-time description: dsLat: type: string description: dsLong: type: string description: qtTempoAtend: type: string format: date-time description: dtJanelaIni: type: string format: date-time description: dtJanelaFim: type: string format: date-time description: nrCep: type: integer format: int64 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: cdOperacao: type: integer format: int64 description: cdTipoCarga: type: integer format: int64 description: dtAgendamento: type: string format: date-time description: dtInclusao: type: string format: date-time description: cdEmbarcador: type: string description: código do embarcador inDocto: type: integer format: int64 description: tipo de documento cdChaveAcesso: type: string description: vlMercadoria: type: number format: double description: default: 0.0 inStatusDisponibilidade: type: boolean description: Tipo de Status situacao: type: string allOf: – #/definitions/situacaoAtividade description: Tipo Situação tipoCarga: type: object allOf: – #/definitions/recTipoCarga description: operacao: type: object allOf: – #/definitions/MCEOPERec description: cdEspCarga: type: integer format: int64 description: grauPrecisao: type: string description: Grau Precisão raioPrecisao: type: integer format: int64 description: Raio Precisão limites: type: string description: Limites MCEOPERec: description: type: object required: – cdOperacao – dsOperacao properties: cdOperacao: type: integer format: int64 description: cdReferencia: type: string description: dsOperacao: type: string description: filiais: type: array items: type: string description: recTipoCarga: description: type: object required: – cdTpCarga properties: cdTpCarga: type: integer format: int64 description: cdTpCargaIncomp: type: integer format: int64 description: dsTipoCarga: type: string description: cdRestricao: type: integer format: int64 description: incompativeis: type: array items: type: object allOf: – #/definitions/recTipoCarga description: inTpRestricao: type: integer format: int64 description: Tipo de restrição: exigir , restringir PaisRec: description: type: object required: – cdIbge properties: cdIbge: type: string description: dsNome: type: string description: dsSigla: type: string description: EstadoRec: description: type: object required: – cdIbge properties: cdIbge: type: string description: dsNome: type: string description: dsSigla: type: string description: pais: type: object allOf: – #/definitions/PaisRec description: CidadeRec: description: type: object required: – cdIbge – estado properties: cdIbge: type: string description: dsNome: type: string description: estado: type: object allOf: – #/definitions/EstadoRec description: PageInfo: description: type: object required: – totalItens – itensPorPagina – pagina properties: totalItens: type: integer format: int64 description: itensPorPagina: type: integer format: int64 description: pagina: type: integer format: int64 description: BuscaRoteirosRec: description: Record para passagem de parâmetros para o método MCEROTControl.busca type: object properties: cdRoteiroIni: type: integer format: int64 description: cdRoteiroFim: type: integer format: int64 description: listaInSit: type: array items: type: integer format: int64 description: nrPlaca: type: string description: nrPlaca2: type: string description: nrPlaca3: type: string description: nrPlaca4: type: string description: dsReferencia: type: string description: nrCNPJFilial: type: string description: idPontoApoio: type: integer format: int64 description: cdRoteirizacao: type: integer format: int64 description: cdMotorista: type: integer format: int64 description: consisteRoteirizacao: type: boolean description: dtIniRotas: type: string format: date-time description: dtAteIni: type: string format: date-time description: cdAtividade: type: integer format: int64 description: dtPrevTermino: type: string format: date-time description: listaCdRoteiro: type: array items: type: integer format: int64 description: offset: type: integer format: int64 description: limit: type: integer format: int64 description: listaCdAtividade: type: array items: type: integer format: int64 description: Lista de códigos de atividades. Limite de 100 códigos inBuscaDepAtividades: type: boolean description: Se deseja buscar os dados completos das atividades vinculadas. Padrão: true default: true inBuscaDepVincAtv: type: boolean description: Se não quer buscar as atividades vinculadas ao roteiro, enviar inBuscaDepAtividades= false e inBuscaDepVincAtv=false default: true inBuscaDepMotorista: type: boolean description: Se deseja buscar os dados completos do motorista vinculado ao roteiro. Padrão: true default: true 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 LatLonRec: description: type: object required: – latitude – longitude properties: latitude: type: string description: longitude: type: string description: rotaFixaRec: description: Record da rota fixa type: object required: – nrCNPJFilial – dsDescricao – inStatus properties: idRotaFixa: type: integer format: int64 description: Identificador da rota fixa nrCNPJFilial: type: string description: CNPJ da filial dsDescricao: type: string description: Descrição da Rota Fixa inStatus: type: boolean description: Status da Rota Fixa destinosRotaFixa: type: array items: type: object allOf: – #/definitions/destinoRotaFixaRec description: Destinos da Rota Fixa MCEGVERec: description: Record do Grupo de Veículo type: object required: – cdGrupoVeiculo – dsGrupoVeiculo properties: cdGrupoVeiculo: type: integer format: int64 description: dsGrupoVeiculo: type: string description: destinoRotaFixaRec: description: Record do destino da rota fixa type: object required: – cdDestino – cdSequencia properties: idDestinoRotaFixa: type: integer format: int64 description: Identificador do Destino da Rota Fixa cdDestino: type: string description: Código do Destino dsDescricao: type: string description: Descrição do Destino cdSequencia: type: integer format: int64 description: Código da Sequência 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 recBuscaRoteirosPorLote: description: Informações do roteiro ao buscar por lote type: object properties: cdRoteiro: type: integer format: int64 description: Código do roteiro sitRoteiro: type: object allOf: – #/definitions/inSitRoteiroRec description: Dados situação do roteiro nrPlaca: type: string description: Placa do veículo motorista: type: object allOf: – #/definitions/recMotorista description: Dados do motorista atividades: type: array items: type: object allOf: – #/definitions/MCEATVRec description: Dados das atividades notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

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