frota

croqui

75 views 07/11/2018 16/01/2020 integrador 0

2.0info: 2.1.1 croqui x-senior-domain: tms x-senior-domain-path: tms x-senior-service-path: croqui contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/tmssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /croqui/queries/validarVeiculo: post: description: Validação de Veículos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – hodometro properties: id: type: integer format: int64 description: Código do Veículo hodometro: type: number format: double description: Hodômetro do Veículo tpmov: type: string allOf: – #/definitions/TipoMovimentoVeiculo description: Tipo de Movimento. Ex: Entrada / Saida responses: 200: description: Ok schema: type: object required: – dsMsgErro – hodometro properties: dsMsgErro: type: string description: Descrição do Erro caso não ok hodometro: type: number format: double description: Hodômetro do Veículo default: description: Error response schema: #/definitions/genericError /croqui/queries/buscaMotorista: post: description: Busca Motorista tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigo: type: integer format: int64 description: Código do Motorista matricula: type: integer format: int64 description: Matricula do Motorista responses: 200: description: Ok schema: type: object required: – dsMsgErro – motorista properties: dsMsgErro: type: string description: Descrição do Erro caso não ok motorista: type: object allOf: – #/definitions/rmotorista description: Dados do Motorista default: description: Error response schema: #/definitions/genericError get: description: Busca Motorista tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigo description: Código do Motorista in: query type: integer format: int64 – name: matricula description: Matricula do Motorista in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – dsMsgErro – motorista properties: dsMsgErro: type: string description: Descrição do Erro caso não ok motorista: type: object allOf: – #/definitions/rmotorista description: Dados do Motorista default: description: Error response schema: #/definitions/genericError /croqui/queries/buscaCheckListVeiculo: post: description: Busca o Checklist vinculado ao Veículo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoveiculo properties: codigoveiculo: type: integer format: int64 description: Código do Veículo responses: 200: description: Ok schema: type: object required: – dsMsgErro – ultimomovimentoveiculo – checklist properties: dsMsgErro: type: string description: Descrição do Erro caso não ok ultimomovimentoveiculo: type: string allOf: – #/definitions/TipoMovimentoVeiculo description: Ultimo Movimento do Veículo. Ex: Entrada / Saida checklist: type: object allOf: – #/definitions/rchecklist description: Checklist default: description: Error response schema: #/definitions/genericError get: description: Busca o Checklist vinculado ao Veículo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoveiculo description: Código do Veículo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – dsMsgErro – ultimomovimentoveiculo – checklist properties: dsMsgErro: type: string description: Descrição do Erro caso não ok ultimomovimentoveiculo: type: string allOf: – #/definitions/TipoMovimentoVeiculo description: Ultimo Movimento do Veículo. Ex: Entrada / Saida checklist: type: object allOf: – #/definitions/rchecklist description: Checklist default: description: Error response schema: #/definitions/genericError /croqui/queries/buscaImagemPerspectiva: post: description: Busca Imagem Vinculada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdCheckList – cdperspectiva properties: cdCheckList: type: integer format: int64 description: Código do Check-List cdperspectiva: type: integer format: int64 description: Código da Perspectiva responses: 200: description: Ok schema: type: object required: – dsMsgErro – imagem – ok properties: dsMsgErro: type: string description: Descrição do Erro caso não ok imagem: type: object allOf: – #/definitions/rimagem description: Imagem ok: type: boolean description: Sucesso na operação default: description: Error response schema: #/definitions/genericError get: description: Busca Imagem Vinculada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdCheckList description: Código do Check-List in: query required: true type: integer format: int64 – name: cdperspectiva description: Código da Perspectiva in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – dsMsgErro – imagem – ok properties: dsMsgErro: type: string description: Descrição do Erro caso não ok imagem: type: object allOf: – #/definitions/rimagem description: Imagem ok: type: boolean description: Sucesso na operação default: description: Error response schema: #/definitions/genericError /croqui/queries/buscaEmpresa: post: description: Busca Empresa Vinculada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigo: type: integer format: int64 description: Código da Empresa responses: 200: description: Ok schema: type: object required: – dsMsgErro – empresa properties: dsMsgErro: type: string description: Descrição do Erro caso não ok empresa: type: array items: type: object allOf: – #/definitions/rempresa minimum: 1 description: Informações da Empresa default: description: Error response schema: #/definitions/genericError get: description: Busca Empresa Vinculada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigo description: Código da Empresa in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – dsMsgErro – empresa properties: dsMsgErro: type: string description: Descrição do Erro caso não ok empresa: type: array items: type: object allOf: – #/definitions/rempresa minimum: 1 description: Informações da Empresa default: description: Error response schema: #/definitions/genericError /croqui/queries/obterUrlUploadFotoPerspectiva: post: description: Obtém Url para enviar a foto da perspectiva tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cdCheckList – cdperspectiva properties: cdCheckList: type: integer format: int64 description: Código do Check-List cdperspectiva: type: integer format: int64 description: Código da Perspectiva 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 default: description: Error response schema: #/definitions/genericError get: description: Obtém Url para enviar a foto da perspectiva tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cdCheckList description: Código do Check-List in: query required: true type: integer format: int64 – name: cdperspectiva description: Código da Perspectiva in: query required: true 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 default: description: Error response schema: #/definitions/genericError /croqui/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /croqui/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /croqui/actions/finalizaCheckList: post: description: Finaliza o CheckList tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vistoria properties: vistoria: type: object allOf: – #/definitions/rvistoria description: Todas informações referente a Vistoria responses: 200: description: Ok schema: type: object required: – dsMsgErro properties: dsMsgErro: type: string description: Descrição do Erro caso não ok default: description: Error response schema: #/definitions/genericError /croqui/actions/salvaEmpresa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresa properties: empresa: type: array items: type: object allOf: – #/definitions/rsalvaempresa minimum: 1 description: responses: 200: description: Ok schema: type: object required: – dsMsgErro properties: dsMsgErro: type: string description: default: description: Error response schema: #/definitions/genericError /croqui/actions/salvaCheckList: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – checklist properties: checklist: type: array items: type: object allOf: – #/definitions/rsalvachecklist minimum: 1 description: responses: 200: description: Ok schema: type: object required: – dsMsgErro properties: dsMsgErro: type: string description: default: description: Error response schema: #/definitions/genericError /croqui/actions/salvaGrupo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – grupo properties: grupo: type: array items: type: object allOf: – #/definitions/rsalvagrupo minimum: 1 description: responses: 200: description: Ok schema: type: object required: – dsMsgErro properties: dsMsgErro: type: string description: default: description: Error response schema: #/definitions/genericError /croqui/actions/salvaGrupoItem: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – grupoitem properties: grupoitem: type: array items: type: object allOf: – #/definitions/rsalvagrupoitem minimum: 1 description: responses: 200: description: Ok schema: type: object required: – dsMsgErro properties: dsMsgErro: type: string description: default: description: Error response schema: #/definitions/genericError /croqui/actions/salvaPerspectiva: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – perspectiva properties: perspectiva: type: array items: type: object allOf: – #/definitions/rsalvaperspectiva minimum: 1 description: responses: 200: description: Ok schema: type: object required: – dsMsgErro – ok properties: dsMsgErro: type: string description: ok: type: boolean description: default: description: Error response schema: #/definitions/genericError /croqui/actions/salvaPerspectivaVinculacao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – perspectivavinculacao properties: perspectivavinculacao: type: array items: type: object allOf: – #/definitions/rsalvaperspectivavinculacao minimum: 1 description: responses: 200: description: Ok schema: type: object required: – dsMsgErro properties: dsMsgErro: type: string description: default: description: Error response schema: #/definitions/genericError /croqui/actions/salvaVeiculo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – veiculo properties: veiculo: type: array items: type: object allOf: – #/definitions/rsalvaveiculo minimum: 1 description: responses: 200: description: Ok schema: type: object required: – dsMsgErro properties: dsMsgErro: type: string description: default: description: Error response schema: #/definitions/genericError /croqui/actions/salvaMotorista: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – motorista properties: motorista: type: array items: type: object allOf: – #/definitions/rsalvamotorista minimum: 1 description: responses: 200: description: Ok schema: type: object required: – dsMsgErro properties: dsMsgErro: type: string description: default: description: Error response schema: #/definitions/genericError /croqui/actions/vinculaMotoristaVeiculo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – motoristaveiculo properties: motoristaveiculo: type: array items: type: object allOf: – #/definitions/rvinculamotoristaveiculo minimum: 1 description: responses: 200: description: Ok schema: type: object required: – dsMsgErro properties: dsMsgErro: type: string description: default: description: Error response schema: #/definitions/genericError /croqui/actions/atualizaTipoMovimentoVeiculo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – atualiza properties: atualiza: type: array items: type: object allOf: – #/definitions/ratualizatipomovimentoveiculo minimum: 1 description: responses: 200: description: Ok schema: type: object required: – dsMsgErro properties: dsMsgErro: type: string description: default: description: Error response schema: #/definitions/genericError definitions: TipoMovimentoVeiculo: description: type: string enum: – Entrada – Saida VistoriaStatus: description: type: string enum: – PENDENTE – INTEGRADO – ERROINTEGRACAO TipoSituacaoVeiculo: description: type: string enum: – INATIVO – ATIVO 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 ratualizatipomovimentoveiculo: description: type: object required: – placa – tipomovimentoveiculo properties: placa: type: string description: tipomovimentoveiculo: type: string allOf: – #/definitions/TipoMovimentoVeiculo description: rsalvaempresa: description: type: object required: – codigo – descricao properties: codigo: type: integer format: int64 description: descricao: type: string description: desativarregistro: type: integer format: int64 description: rsalvachecklist: description: type: object required: – codigo – descricao properties: codigo: type: integer format: int64 description: descricao: type: string description: desativarregistro: type: integer format: int64 description: rsalvagrupo: description: type: object required: – checklist – idgruporeferencia – codigo – descricao properties: checklist: type: integer format: int64 description: idgruporeferencia: type: integer format: int64 description: codigo: type: integer format: int64 description: descricao: type: string description: desativarregistro: type: integer format: int64 description: rsalvagrupoitem: description: type: object required: – idgruporeferencia – idgrupoitemreferencia – codigo – descricao properties: idgruporeferencia: type: integer format: int64 description: idgrupoitemreferencia: type: integer format: int64 description: codigo: type: integer format: int64 description: descricao: type: string description: desativarregistro: type: integer format: int64 description: rsalvaperspectiva: description: type: object required: – codigo – checklist – descricao – imagem – largura – altura – idArquivo – versao properties: codigo: type: integer format: int64 description: checklist: type: integer format: int64 description: descricao: type: string description: imagem: type: string description: largura: type: integer format: int64 description: altura: type: integer format: int64 description: desativarregistro: type: integer format: int64 description: idArquivo: type: string description: versao: type: string description: rsalvaperspectivavinculacao: description: type: object required: – codigo – perspectiva – idgruporeferencia – checklist – InPosXIni – InPosXFim – InPosYIni – InPosYFim properties: codigo: type: integer format: int64 description: perspectiva: type: integer format: int64 description: idgruporeferencia: type: integer format: int64 description: checklist: type: integer format: int64 description: InPosXIni: type: integer format: int64 description: InPosXFim: type: integer format: int64 description: InPosYIni: type: integer format: int64 description: InPosYFim: type: integer format: int64 description: TmAltura: type: integer format: int64 description: TmLargura: type: integer format: int64 description: desativarregistro: type: integer format: int64 description: rsalvaveiculo: description: type: object required: – codigo – placa properties: codigo: type: integer format: int64 description: placa: type: string description: hodometro: type: number format: double description: checklist: type: integer format: int64 description: desativarregistro: type: integer format: int64 description: rsalvamotorista: description: type: object required: – codigo – matricula – nome properties: codigo: type: integer format: int64 description: matricula: type: integer format: int64 description: nome: type: string description: desativarregistro: type: integer format: int64 description: rvinculamotoristaveiculo: description: type: object required: – veiculo – funcionario – relacionamento properties: veiculo: type: integer format: int64 description: funcionario: type: integer format: int64 description: relacionamento: type: string format: date description: desativarregistro: type: integer format: int64 description: rvistoriabusca: description: type: object required: – id – tipomovimentoveiculo – empresacodigo – motoristacodigo – checklistcodigo – veiculocodigo – hodometro – vistoriaitem properties: id: type: integer format: int64 description: tipomovimentoveiculo: type: string allOf: – #/definitions/TipoMovimentoVeiculo description: empresacodigo: type: integer format: int64 description: motoristacodigo: type: integer format: int64 description: checklistcodigo: type: integer format: int64 description: veiculocodigo: type: integer format: int64 description: hodometro: type: number format: double description: vistoriaitem: type: array items: type: object allOf: – #/definitions/rvistoriaitembusca minimum: 1 description: rvistoriaitembusca: description: type: object required: – grupocodigo – grupoitemcodigo properties: grupocodigo: type: integer format: int64 description: grupoitemcodigo: type: integer format: int64 description: rvistoria: description: type: object required: – movimentoveiculo – idchecklist – idveiculo – idempresa – idmotorista – hodometro properties: movimentoveiculo: type: string allOf: – #/definitions/TipoMovimentoVeiculo description: idchecklist: type: integer format: int64 description: idveiculo: type: integer format: int64 description: idempresa: type: integer format: int64 description: idmotorista: type: integer format: int64 description: hodometro: type: number format: double description: grupo: type: array items: type: object allOf: – #/definitions/rgrupovistoria description: rgrupovistoria: description: type: object required: – id – grupoitem properties: id: type: integer format: int64 description: grupoitem: type: array items: type: object allOf: – #/definitions/rgrupoitemvistoria minimum: 1 description: rgrupoitemvistoria: description: type: object required: – id properties: id: type: integer format: int64 description: rempresa: description: type: object required: – id – codigo – descricao properties: id: type: integer format: int64 description: codigo: type: integer format: int64 description: descricao: type: string description: rchecklist: description: type: object required: – id – codigo – descricao – veiculo – perspectiva properties: id: type: integer format: int64 description: codigo: type: integer format: int64 description: descricao: type: string description: veiculo: type: object allOf: – #/definitions/rveiculo description: perspectiva: type: array items: type: object allOf: – #/definitions/rperspectiva minimum: 1 description: rveiculo: description: type: object required: – id – CdVeiculo – hodometro – motorista – situacao properties: id: type: integer format: int64 description: CdVeiculo: type: integer format: int64 description: hodometro: type: number format: double description: motorista: type: object allOf: – #/definitions/rmotorista description: situacao: type: string allOf: – #/definitions/TipoSituacaoVeiculo description: rmotorista: description: type: object required: – id – codigo – matricula – Nome properties: id: type: integer format: int64 description: codigo: type: integer format: int64 description: matricula: type: integer format: int64 description: Nome: type: string description: rperspectiva: description: type: object required: – id – codigo – descricao – datauploadimagem – perspectivavinculacao properties: id: type: integer format: int64 description: codigo: type: integer format: int64 description: descricao: type: string description: datauploadimagem: type: string format: date description: perspectivavinculacao: type: array items: type: object allOf: – #/definitions/rperspectivavinculacao minimum: 1 description: rimagem: description: type: object required: – cdperspectiva – idperspectiva – dsMsgErro – altura – largura – dataupload – idBlobServiceFile – fileName – urlAcesso – dtArquivoDisponivelAte properties: cdperspectiva: type: integer format: int64 description: idperspectiva: type: integer format: int64 description: dsMsgErro: type: string description: altura: type: integer format: int64 description: largura: type: integer format: int64 description: dataupload: type: string format: date description: idBlobServiceFile: type: string description: 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 rperspectivavinculacao: description: type: object required: – id – posicaoInicialX – posicaoInicialY – posicaoFinalX – posicaoFinalY – altura – largura – grupo properties: id: type: integer format: int64 description: posicaoInicialX: type: integer format: int64 description: posicaoInicialY: type: integer format: int64 description: posicaoFinalX: type: integer format: int64 description: posicaoFinalY: type: integer format: int64 description: altura: type: integer format: int64 description: largura: type: integer format: int64 description: grupo: type: object allOf: – #/definitions/rgrupo description: rgrupo: description: type: object required: – id – descricao – grupoitem properties: id: type: integer format: int64 description: descricao: type: string description: grupoitem: type: array items: type: object allOf: – #/definitions/rgrupoitem minimum: 1 description: desativarregistro: type: integer format: int64 description: rgrupoitem: description: type: object required: – id – descricao properties: id: type: integer format: int64 description: descricao: type: string description: desativarregistro: type: integer format: int64 description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment