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

driverapp

134 views 0 30/06/2022 Atualizado em 01/08/2024 integrador

2.0info: 4.1.7 driverapp description: Serviço do App x-senior-domain: tmsentregas x-senior-domain-path: tmsentregas x-senior-service-path: driverapp 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: /driverapp/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 /driverapp/queries/buscaRota: post: description: Retorna as atividades da rota em execução do motorista 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 identificador da rota responses: 200: description: Ok schema: type: object required: – rota properties: rota: type: object allOf: – #/definitions/recDadosRota description: Dados da Rota 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as atividades da rota em execução do motorista tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteiro description: Código identificador da rota in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – rota properties: rota: type: object allOf: – #/definitions/recDadosRota description: Dados da Rota 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/queries/buscaAtividades: post: description: Retorna as atividades da rota em execução do motorista tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdMotorista properties: cdMotorista: type: integer format: int64 description: Código identificador do motorista minimum: 1 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/recAtividade minimum: 1 description: Lista de Atividades inOrdListaAtvPorLocal: type: integer format: int64 description: Ordenar listagem de atividades por localização inExigeApontamentoSeq: type: integer format: int64 description: Exige que o apontamento no aplicativo seja feita na ordem planejada. ATENÇÃO: essa funcionalidade é desabilitada caso a rota seja alterada após a execução dsApelido: type: string description: Apelido da filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as atividades da rota em execução do motorista tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdMotorista description: Código identificador do motorista in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaResultado properties: listaResultado: type: array items: type: object allOf: – #/definitions/recAtividade minimum: 1 description: Lista de Atividades inOrdListaAtvPorLocal: type: integer format: int64 description: Ordenar listagem de atividades por localização inExigeApontamentoSeq: type: integer format: int64 description: Exige que o apontamento no aplicativo seja feita na ordem planejada. ATENÇÃO: essa funcionalidade é desabilitada caso a rota seja alterada após a execução dsApelido: type: string description: Apelido da filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/queries/obtemMotorista: post: description: Retorna o motorista que está logado no app, vinculado pelo usuário da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – usuarioPlataforma properties: usuarioPlataforma: type: string description: Código identificador do usuario na plataforma responses: 200: description: Ok schema: type: object required: – motorista properties: motorista: type: object allOf: – #/definitions/recMotoristaApp description: Retorno do código do motorista vinculado ao usuário da plataforma 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o motorista que está logado no app, vinculado pelo usuário da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: – name: usuarioPlataforma description: Código identificador do usuario na plataforma in: query required: true type: string responses: 200: description: Ok schema: type: object required: – motorista properties: motorista: type: object allOf: – #/definitions/recMotoristaApp description: Retorno do código do motorista vinculado ao usuário da plataforma 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/queries/buscaTiposOcorrencia: post: description: Busca todos os tipos de ocorrência ativos desde o código de inicio até o último código registrado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdTipoOcorrenciaIni properties: cdTipoOcorrenciaIni: type: integer format: int64 description: Código identificador do tipo de ocorrência. Caso informado valor menor ou igual a zero, retorna todos os ativos. responses: 200: description: Ok schema: type: object required: – tiposOcorrencia properties: tiposOcorrencia: type: array items: type: object allOf: – #/definitions/tipoOcorrenciaRec minimum: 1 description: Retorna os tipos de ocorrência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca todos os tipos de ocorrência ativos desde o código de inicio até o último código registrado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdTipoOcorrenciaIni description: Código identificador do tipo de ocorrência. Caso informado valor menor ou igual a zero, retorna todos os ativos. in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – tiposOcorrencia properties: tiposOcorrencia: type: array items: type: object allOf: – #/definitions/tipoOcorrenciaRec minimum: 1 description: Retorna os tipos de ocorrência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/queries/buscaTiposOcorrenciaEmbarcador: post: description: Busca todos os tipos de ocorrência ativos vinculados ao embarcador 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 identificador do roteiro. responses: 200: description: Ok schema: type: object required: – tiposOcorrenciaEmbarcador properties: tiposOcorrenciaEmbarcador: type: array items: type: object allOf: – #/definitions/tipoOcorrenciaEmbarcadorRec minimum: 1 description: Retorna os tipos de ocorrência do embarcador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca todos os tipos de ocorrência ativos vinculados ao embarcador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteiro description: Código identificador do roteiro. in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – tiposOcorrenciaEmbarcador properties: tiposOcorrenciaEmbarcador: type: array items: type: object allOf: – #/definitions/tipoOcorrenciaEmbarcadorRec minimum: 1 description: Retorna os tipos de ocorrência do embarcador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/queries/insereRespostasQuestionario: post: description: Grava resposta de apontamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – rota – atividade – sequenciaOcorrencia – regra – questionario – respostasPerguntas properties: rota: type: integer format: int64 description: Código identificador do roteiro. atividade: type: integer format: int64 description: Código identificador da atividade. sequenciaOcorrencia: type: integer format: int64 description: sequencia_ocorrencia regra: type: integer format: int64 description: código da regra do checklist atendida questionario: type: integer format: int64 description: Código do questionário respostasPerguntas: type: array items: type: object allOf: – #/definitions/recRespostaPergunta minimum: 1 description: Lista de respostas de respectivas perguntas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/queries/buscaQuestionarios: post: description: Busca os questionários com perguntas da rota 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 identificador do roteiro. responses: 200: description: Ok schema: type: object required: – questionarioAtividade – questionarios properties: questionarioAtividade: type: array items: type: object allOf: – #/definitions/recQuestionarioAtividade minimum: 1 description: Relação questionário – atividade – ocorrencia questionarios: type: array items: type: object allOf: – #/definitions/recQuestionarioPerguntas minimum: 1 description: Retorna os tipos de ocorrência do embarcador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os questionários com perguntas da rota tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdRoteiro description: Código identificador do roteiro. in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – questionarioAtividade – questionarios properties: questionarioAtividade: type: array items: type: object allOf: – #/definitions/recQuestionarioAtividade minimum: 1 description: Relação questionário – atividade – ocorrencia questionarios: type: array items: type: object allOf: – #/definitions/recQuestionarioPerguntas minimum: 1 description: Retorna os tipos de ocorrência do embarcador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/queries/obterAcessoDownloadFotoOcorrencia: post: description: Obtém os dados necessários para realizar o Download de um arquivo ao informar seu o Id do aqruivo salvo no serviço de arquivos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idBlobServiceFile properties: idBlobServiceFile: type: string description: Id do arquivo salvo no serviço de arquivos responses: 200: description: Ok schema: type: object required: – dadosArquivoSoliciatado properties: dadosArquivoSoliciatado: type: object allOf: – #/definitions/dadosAcessoArquivo description: Dados de acesso para realizar download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os dados necessários para realizar o Download de um arquivo ao informar seu o Id do aqruivo salvo no serviço de arquivos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idBlobServiceFile description: Id do arquivo salvo no serviço de arquivos in: query required: true type: string responses: 200: description: Ok schema: type: object required: – dadosArquivoSoliciatado properties: dadosArquivoSoliciatado: type: object allOf: – #/definitions/dadosAcessoArquivo description: Dados de acesso para realizar download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/queries/obterUrlUploadFotoOcorrencia: post: description: Obtém Url para enviar a foto da ocorrencia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade – cdSeqOcorrencia properties: cdAtividade: type: integer format: int64 description: Código da Atividade cdSeqOcorrencia: type: integer format: int64 description: Código sequencial da Ocorrência cdSeqImagem: type: integer format: int64 description: Código sequencial da foto na Ocorrência. Opcional, sendo vazio igual a 1 default: 1 cdRoteiro: type: integer format: int64 description: Código do roteiro. Opcional responses: 200: description: Ok schema: type: object required: – id – url – nome – versao – ok – imagemExists – dsErro properties: id: type: string description: id unico do arquivo no serviço url: type: string description: URL para upload do arquivo nome: type: string description: nome do arquivo versao: type: string description: versão do arquivo criado ok: type: boolean description: Sucesso na operação imagemExists: type: boolean description: Indica se a imagem já existe dsErro: type: string description: Mensagem caso erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém Url para enviar a foto da ocorrencia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdAtividade description: Código da Atividade in: query required: true type: integer format: int64 – name: cdSeqOcorrencia description: Código sequencial da Ocorrência in: query required: true type: integer format: int64 – name: cdSeqImagem description: Código sequencial da foto na Ocorrência. Opcional, sendo vazio igual a 1 in: query type: integer format: int64 – name: cdRoteiro description: Código do roteiro. Opcional in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – id – url – nome – versao – ok – imagemExists – dsErro properties: id: type: string description: id unico do arquivo no serviço url: type: string description: URL para upload do arquivo nome: type: string description: nome do arquivo versao: type: string description: versão do arquivo criado ok: type: boolean description: Sucesso na operação imagemExists: type: boolean description: Indica se a imagem já existe dsErro: type: string description: Mensagem caso erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/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 /driverapp/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 /driverapp/actions/insereOcorrencia: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ocorrencia properties: ocorrencia: type: object allOf: – #/definitions/ocorrenciaRec description: Ocorrência para o registro responses: 200: description: Ok schema: type: object required: – ok – dsErro – ocorrencia properties: ok: type: boolean description: Identificador de sucesso na operacao dsErro: type: string description: Mensagem de erro da operacao, caso ocorra ocorrencia: type: object allOf: – #/definitions/ocorrenciaRec description: Retorna a ocorrência inserida 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/actions/insereLocalizacaoVeiculo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – localizacoes properties: localizacoes: type: array items: type: object allOf: – #/definitions/localizacaoRec minimum: 1 description: Lista de localizações para o registro responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/actions/insereLog: post: description: Inserção de log do dispositivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: localizacao: type: object allOf: – #/definitions/recLocalizacao description: Localização de onde disparou o log versionApp: type: integer format: int64 description: Versão instalada do aplicativo utilizada no dispositivo que realizou o envio cdRoteiro: type: integer format: int64 description: Roteiro ao qual o log foi registrado nrPlaca: type: string description: Placa do veículo model: type: string description: Modelo do aparelho message: type: string description: Mensagem do log dateLog: type: string description: Data do registro do log manufacturer: type: string description: Fabricante serviceStatus: type: object allOf: – #/definitions/recServiceStatus description: Status do servico de localização do dispositivo networkType: type: string description: Tipo de rede do dispositivo sdk: type: integer format: int64 description: Versão SDK Android do dispositivo Ex.: 27 release: type: string description: Versão Android do dispositivo Ex.: 8.1.0 brand: type: string description: Marca do dispositivo Ex.: Motorola fingerprint: type: boolean description: Informação se o dispositivo tem biometria responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/actions/confirmarUploadFotoOcorrencia: post: description: Confirma a gravação do arquivo no serviço na versão em que ocorreu o upload tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade – cdSeqOcorrencia – id – nomeAnexo – versao properties: cdAtividade: type: integer format: int64 description: Código da Atividade cdSeqOcorrencia: type: integer format: int64 description: Código sequencial da Ocorrência cdSeqImagem: type: integer format: int64 description: Código sequencial da foto do comprovante. Opcional, sendo vazio igual a 1 default: 1 cdRoteiro: type: integer format: int64 description: Código do roteiro. Opcional cdTipoOcorrencia: type: integer format: int64 description: Código do tipo da ocorrência. Opcional id: type: string description: id unico do arquivo no serviço nomeAnexo: type: string description: nome do anexo versao: type: string description: versão do anexo (obtida no retorno da primitiva obterUrlUploadAnexo) origem: type: string maxLength: 100 description: Origem do comprovante comprovanteValido: type: boolean description: Identificação se foi capturado um comprovante válido responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/actions/insereAssinaturaOcorrencia: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdAtividade – cdSeqOcorrencia – dsImgAssinatura properties: cdAtividade: type: integer format: int64 description: cdSeqOcorrencia: type: integer format: int64 description: dsImgAssinatura: type: string format: byte description: responses: 200: description: Ok schema: type: object required: – ok – dsErro properties: ok: type: boolean description: Sucesso na operação dsErro: type: string description: Mensagem caso erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /driverapp/events/posicaoVeiculoAtualizada: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – dados properties: dados: type: object allOf: – #/definitions/localizacaoRec description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /driverapp/events/atualizaTemposExecucaoOcorrencias: post: description: Atualiza os tempos de execução, transito e distância das ocorrências, além de atribuir a atividade ao trajeto do veículo x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ocorrencias properties: ocorrencias: type: array items: type: object allOf: – #/definitions/atualizaTemposOcorrenciaRec minimum: 1 description: Lista com ocorrências para atualizar responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /driverapp/events/ocorrenciaInserida: post: description: Informa que houve o lançamento de uma ocorrência no aplicativo do motorista x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ocorrencia properties: ocorrencia: type: object allOf: – #/definitions/ocorrenciaRec description: Ocorrencia responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /driverapp/events/fotoOcorrenciaInserida: post: description: Informa que a foto de uma ocorrência foi inserida, buscar a foto utilizando o método buscaDadosRecebedor x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – cdAtividade – cdSeqOcorrencia – dsNomeArquivo – dsTipoArquivo – idBlobServiceFile properties: cdAtividade: type: integer format: int64 description: código da atividade inserida cdSeqOcorrencia: type: integer format: int64 description: sequência da ocorrência inserida cdSeqImagem: type: integer format: int64 description: Código sequencial da foto cdRoteiro: type: integer format: int64 description: Código do roteiro cdTipoOcorrencia: type: integer format: int64 description: Código da ocorrência dsNomeArquivo: type: string description: nome do arquivo dsTipoArquivo: type: string description: tipo do arquivo (.jpg) idBlobServiceFile: type: string description: id do arquivo no blob service, para consulta via obterAcessoDownloadFotoOcorrencia – idBlobServiceFile responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /driverapp/events/assinaturaOcorrenciaInserida: post: description: Informa que a assinatura de uma ocorrência foi inserida, buscar a assinatura utilizando o método buscaDadosRecebedor x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – cdAtividade – cdSeqOcorrencia properties: cdAtividade: type: integer format: int64 description: código da atividade inserida cdSeqOcorrencia: type: integer format: int64 description: sequência da ocorrência inserida responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: enumeradorExigeDadosComplementares: description: type: string enum: – NAO_UTILIZA – OPCIONAL – OBRIGATORIO enumeradorExigeDetalhesEntrega: description: type: string enum: – NAO_UTILIZA – OPCIONAL – OBRIGATORIO 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 enumTipoResposta: description: Enum tipo de respota type: string enum: – NUMERO – TEXTO – SIM_NAO origemComprovante: description: Origem do comprovante type: string enum: – APP – PLATAFORMA 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 recServiceStatus: description: Informação sobre o serviço de localização em background type: object properties: authorization: type: integer format: int64 description: hasPermissions: type: boolean description: isRunning: type: boolean description: locationServicesEnabled: type: boolean description: recLocalizacao: description: Informação da latitude e longitude do dispositivo type: object required: – lat – lon properties: lat: type: string description: lon: type: string description: recDadosRota: description: Dados da Rota do motorista type: object required: – situacao – execucao properties: situacao: type: integer format: int64 description: execucao: type: string format: date-time description: termino: type: string format: date-time description: recAtividade: description: Modelo de retorno da atividade do motorista type: object required: – inAtividade – dsDestinatario – qtPeso – dsNrDocto properties: cdAtividade: type: integer format: int64 description: inAtividade: type: integer format: int64 description: dsDestinatario: type: string description: cdDestino: 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: qtVolume: type: number format: double description: qtPeso: type: number format: double description: dsNrDocto: type: string description: dsLat: type: string description: dsLong: type: string description: nrCep: type: integer format: int64 description: nrTelefoneContato: type: string description: dtJanelaIni: type: string format: date-time description: dtJanelaFim: type: string format: date-time description: qtTempoAtend: type: string format: date-time description: qtMetrosCubicos: type: number format: double description: dsObservacao: type: string description: cdRoteiro: type: integer format: int64 description: dtPrevEntr: type: string format: date-time description: cdSeqExecucao: type: integer format: int64 description: cdMotorista: type: integer format: int64 description: nrPlaca: type: string description: dtAgendamento: type: string format: date-time description: inIncPosterior: type: integer format: int64 description: nrCNPJFilial: type: string description: cdOperacao: type: integer format: int64 description: cdTipoCarga: type: integer format: int64 description: dtInclusao: type: string format: date-time description: dtPrazoEntr: type: string format: date-time description: Data do Prazo de Entrega. opcional para a modalidade de transporte lotação dtRealizado: type: string format: date-time description: hrLimite: type: string format: date-time description: inPrioridade: type: integer format: int64 description: inStatus: type: integer format: int64 description: Status de Aceite, onde 0-Recusada, 1-Em Análise, 2-Aceita dsMotivo: type: string description: Motivo do status. Ex: Grau mínimo de confiança do endereço não atingido cdEmbarcador: type: string description: Código do embarcador inDocto: type: integer format: int64 description: código do Tipo de documento cdComposicao: type: integer format: int64 description: Código da composição cdChaveAcesso: type: string description: Chave eletrônica de acesso referente ao documento fiscal representado vlMercadoria: type: number format: double description: Valor da Mercadoria default: 0.0 inStatusDisponibilidade: type: boolean description: Tipo de Status situacao: type: string allOf: – #/definitions/situacaoAtividade description: Tipo Situação recMotoristaApp: description: type: object properties: cdMotorista: type: integer format: int64 description: tipoOcorrenciaRec: description: Modelo de retorno para os tipos de ocorrência type: object required: – codigo – dsApelidoWAP – cdSituacao – cdTpAtividade properties: codigo: type: integer format: int64 description: dsApelidoWAP: type: string description: cdSituacao: type: integer format: int64 description: cdTpAtividade: type: integer format: int64 description: inExibeContatoFone: type: integer format: int64 description: inAnexComprEntrDigit: type: integer format: int64 description: inSolicAssinaturaMOB: type: integer format: int64 description: inExigeObs: type: integer format: int64 description: inExigeDadosComplementares: type: string allOf: – #/definitions/enumeradorExigeDadosComplementares description: inExigeDetalhesEntrega: type: string allOf: – #/definitions/enumeradorExigeDetalhesEntrega description: inGerarEtiqueta: type: integer format: int64 description: Indica se o tipo da ocorrência gera etiqueta inValidaDocumento: type: boolean description: Indica se é para validar o documento informado default: false validarComprovante: type: boolean description: Validar foto do comprovante de entrega default: false tipoOcorrenciaEmbarcadorRec: description: Modelo de retorno para os tipos de ocorrência type: object required: – cdAtividade – cdEmbarcador – tiposOcorrencia properties: cdAtividade: type: integer format: int64 description: Código da atividade cdEmbarcador: type: string description: Código da embarcador tiposOcorrencia: type: array items: type: integer format: int64 minimum: 1 description: Tipos de ocorrência vinculados ao embarcador 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 ocorrenciaRec: description: Modelo de ocorrência para o movimento (MCEATVMV) type: object required: – cdAtividade – cdRoteiro – cdOcorrencia – dtMovimento – dsUsuario properties: cdAtividade: type: integer format: int64 description: cdRoteiro: type: integer format: int64 description: cdOcorrencia: type: integer format: int64 description: cdSequencia: type: integer format: int64 description: dtMovimento: type: string format: date-time description: dsComplementoOcorr: type: string description: dsLatitude: type: string description: dsLongitude: type: string description: dsUsuario: type: string description: nrDoctoIdentPessoal: type: string description: nrFoneContato: type: string description: dsContato: type: string description: dsFoto: type: string format: byte description: dsImgAssinatura: type: string format: byte description: cdVersaoApp: type: integer format: int64 description: Versão instalada do aplicativo móvel utilizada no dispositivo que realizou o envio dsNrDocto: type: string description: cdChaveAcesso: type: string description: dtPosIni: type: string format: date-time description: peso: type: number format: double description: volume: type: number format: double description: quantidade: type: integer format: int64 description: hodometro: type: number format: double description: idGrauParentesco: type: integer format: int64 description: descricaoGrauParentesco: type: string description: numeroResidencia: type: string description: caixaLacrada: type: boolean description: conferidoSemFalta: type: boolean description: qtImagens: type: integer format: int64 description: Quantidade de imagens registradas na ocorrência motivoComprovanteInvalido: type: string maxLength: 100 description: Motivo por não capturar um comprovante válido localizacaoRec: description: type: object required: – cdRoteiro – nrPlaca – cdVersaoApp – dsLatitude – dsLongitude – hrAtualizacao – timeZone – odometer – speed properties: sequencia: type: integer format: int64 description: cdRoteiro: type: integer format: int64 description: nrPlaca: type: string description: cdVersaoApp: type: integer format: int64 description: dsLatitude: type: string description: dsLongitude: type: string description: hrAtualizacao: type: string format: date-time description: timeZone: type: string description: odometer: type: number format: double description: speed: type: number format: double description: entradaSaidaRec: description: type: object required: – cdAtividade properties: cdAtividade: type: integer format: int64 description: Código da atividade cdSequencia: type: integer format: int64 description: Sequência do registro dsUsuario: type: string description: Usuário responsável pelo registro dtHrEntrada: type: string format: date-time description: Data e hora de entrada dtHrSaida: type: string format: date-time description: Data e hora de saída dsLatitudeEntrada: type: string description: Latitude de entrada dsLongitudeEntrada: type: string description: Longitude de entrada dsLatitudeSaida: type: string description: Latitude de saída dsLongitudeSaida: type: string description: Longitude de saída cdVersaoApp: type: integer format: int64 description: Versão instalada do aplicativo móvel utilizada no dispositivo que realizou o envio cdRoteiro: type: integer format: int64 description: Código da Rota em que a Entra e Saída da atividade foi registrada atualizaTemposOcorrenciaRec: description: type: object required: – cdAtividade – cdSequencia – cdOcorrencia – cdRoteiro – dtPosIni – dtMovimento properties: cdAtividade: type: integer format: int64 description: cdSequencia: type: integer format: int64 description: cdOcorrencia: type: integer format: int64 description: cdRoteiro: type: integer format: int64 description: dtPosIni: type: string format: date-time description: dtMovimento: type: string format: date-time description: dadosAcessoArquivo: description: Define os dados de acesso ao arquivo salvo no serviço de atividades type: object required: – ok – msgErro – idBlobServiceFile – fileName – urlAcesso – dtArquivoDisponivelAte properties: ok: type: boolean description: Indica o status do retorno msgErro: type: string description: Mensagem de erro quando houver idBlobServiceFile: type: string description: Id do Arquivo no serviço de arquivos fileName: type: string description: Nome do arquivo urlAcesso: type: string description: Url para realizar o download dtArquivoDisponivelAte: type: string format: date-time description: Data limite para acessar realizar o download recQuestionarioAtividade: description: Questionario atividade type: object required: – cdAtividade – ocorrenciaQuestionario properties: cdAtividade: type: integer format: int64 description: Atividade ocorrenciaQuestionario: type: array items: type: object allOf: – #/definitions/recOcorrenciaQuestionario minimum: 1 description: Questionarios de determinadas ocorrências recOcorrenciaQuestionario: description: Questionario de determinada ocorrência type: object required: – ocorrencia – questionario – regra properties: ocorrencia: type: integer format: int64 description: Ocorrencia questionario: type: integer format: int64 description: questionário regra: type: integer format: int64 description: Regra recRespostaPergunta: description: Resposta Pergunta type: object required: – pergunta properties: pergunta: type: string description: UUID pergunta resposta: type: string description: Resposta recQuestionarioPerguntas: description: Questionário Perguntas type: object required: – codigo – descricao – perguntas properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição perguntas: type: array items: type: object allOf: – #/definitions/recPergunta minimum: 1 description: Lista de Perguntas recPergunta: description: Pergunta do checklist type: object properties: id: type: string description: UUID referencia: type: string description: Campo referência para controle de perguntas por parte do usuário descricao: type: string description: Descrição da pergunta obrigatorio: type: boolean description: Obrigatorio responder a pergunta tipoResposta: type: string allOf: – #/definitions/enumTipoResposta description: Tipo de resposta tamanhoMinimo: type: integer format: int64 description: Tamanho mínimo da pergunta tamanhoMaximo: type: integer format: int64 description: Tamanho máximo da pergunta 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