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

frotas

356 views 0 07/05/2024 Atualizado em 22/08/2024 integrador

2.0info: 0.1.14 frotas description: Serviço para Gestão de Frotas x-senior-domain: tms x-senior-domain-path: tms x-senior-service-path: frotas 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/tmssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /frotas/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/enumUpDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/recCheckData 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/enumUpDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/recCheckData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/queries/obterUrlUploadAnexo: post: description: Obtém a Url para realizar o upload do arquivo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeArquivo properties: nomeArquivo: type: string maxLength: 255 description: Nome do arquivo que será anexado responses: 200: description: Ok schema: type: object required: – id – url – nome – versao properties: id: type: string maxLength: 255 description: Id único do arquivo no serviço url: type: string maxLength: 255 description: URL para upload do arquivo nome: type: string maxLength: 255 description: Nome do arquivo, informado no input versao: type: string maxLength: 255 description: Versão do arquivo criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a Url para realizar o upload do arquivo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: nomeArquivo description: Nome do arquivo que será anexado in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – id – url – nome – versao properties: id: type: string maxLength: 255 description: Id único do arquivo no serviço url: type: string maxLength: 255 description: URL para upload do arquivo nome: type: string maxLength: 255 description: Nome do arquivo, informado no input versao: type: string maxLength: 255 description: Versão do arquivo criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/queries/obterUrlDownloadAnexo: post: description: Obtém a URL para download do arquivo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeArquivo properties: nomeArquivo: type: string maxLength: 255 description: Nome do arquivo que foi anexado responses: 200: description: Ok schema: type: object required: – url properties: url: type: string maxLength: 255 description: URL para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a URL para download do arquivo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: nomeArquivo description: Nome do arquivo que foi anexado in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – url properties: url: type: string maxLength: 255 description: URL para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/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 maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 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 maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/queries/exportAbastecimento: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/queries/exportTelemetriaEvento: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/queries/exportEvento: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/queries/exportTelemetria: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/queries/exportServicoExternoOrdemServico: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/queries/exportPecaExternaOrdemServico: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/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 /frotas/actions/salvarAnexoOrdemServico: post: description: Confirma a gravação do arquivo no serviço e na versão em que ocorreu o upload e vincula na ordem de serviço tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nome – versao – codigoEmpresa – codigoOrdemServico properties: nome: type: string maxLength: 255 description: Nome do arquivo versao: type: string maxLength: 255 description: Versão do arquivo criado – obtida no retorno da primitiva obterUrlUploadAnexo extensao: type: string maxLength: 255 description: Extensão do arquivo codigoEmpresa: type: integer format: int64 description: Código da empresa da ordem de serviço codigoOrdemServico: type: integer format: int64 description: Código da ordem de serviço responses: 200: description: Ok schema: type: object required: – result properties: result: type: string allOf: – #/definitions/enumStatusAction description: Resultado da operação – OK ou ERRO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/actions/excluirAnexo: post: description: Exclui o anexo do repositório tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nome properties: nome: type: string maxLength: 255 description: Nome do arquivo responses: 200: description: Ok schema: type: object required: – result properties: result: type: string allOf: – #/definitions/enumStatusAction description: Resultado da operação – OK ou ERRO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/actions/alteraOrdemServico: post: description: Manutenção de veículos – Altera ordem de serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoOrdemServico – codigoSituacao properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoOrdemServico: type: integer format: int64 description: Código da Ordem de Serviço codigoSituacao: type: integer format: int64 description: Código da situação numeroProtocolo: type: string maxLength: 30 description: Número do protocolo de atendimento dataProtocolo: type: string format: date-time description: Data de criação do protocolo de atendimento dataConclusaoPrevista: type: string format: date-time description: Data prevista para a conclusão da ordem de serviço responses: 200: description: Ok schema: type: object required: – codigoEmpresa – codigoOrdemServico – codigoSituacao – numeroProtocolo – dataProtocolo – dataConclusaoPrevista properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoOrdemServico: type: integer format: int64 description: Código da ordem de serviço codigoSituacao: type: integer format: int64 description: Código da situação numeroProtocolo: type: string maxLength: 30 description: Número do protocolo de atendimento dataProtocolo: type: string format: date-time description: Data de criação do protocolo de atendimento dataConclusaoPrevista: type: string format: date-time description: Data prevista para a conclusão da ordem de serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/actions/importAbastecimento: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/actions/importTelemetriaEvento: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/actions/importEvento: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/actions/importTelemetria: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/actions/importServicoExternoOrdemServico: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/actions/importPecaExternaOrdemServico: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/events/arquivoOrdemServicoCreated: post: description: Evento de gravação do arquivo para a ordem de serviço x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoOrdemServico – urlDownload – nomeArquivo – versaoArquivo – extensao properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoOrdemServico: type: integer format: int64 description: Código da ordem de serviço urlDownload: type: string maxLength: 255 description: URL para download do arquivo nomeArquivo: type: string maxLength: 255 description: Nome do arquivo versaoArquivo: type: string maxLength: 255 description: Versão do arquivo extensao: type: string maxLength: 255 description: Extensão do arquivo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/vinculacaoCartaoVeiculoCreated: post: description: Evento de criação da vinculação de um cartão em um veículo x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – codigoCartao – codigoVeiculo properties: codigoCartao: type: integer format: int64 description: Número do cartão codigoVeiculo: type: integer format: int64 description: Código do veículo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/ordemServicoUpdated: post: description: Evento de atualização da ordem de serviço x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – codigoEmpresa – codigoOrdemServico – codigoSituacao properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoOrdemServico: type: integer format: int64 description: Código da ordem de serviço codigoSituacao: type: integer format: int64 description: Código da situação numeroProtocolo: type: string maxLength: 30 description: Número do protocolo de atendimento dataProtocolo: type: string format: date-time description: Data de criação do protocolo de atendimento dataConclusaoPrevista: type: string format: date-time description: Data prevista para a conclusão da ordem de serviço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/ordemServicoCreated: post: description: Evento de criação da ordem de serviço x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ordemServico properties: ordemServico: type: object allOf: – #/definitions/ordemServicoInput description: Dados da ordem de serviço criada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/veiculoCreated: post: description: Evento de criação de um veículo x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – placa properties: placa: type: string maxLength: 255 description: Placa do veículo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/abastecimentoCreated: post: description: Evento de criação de um abastecimento x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – abastecimento properties: abastecimento: type: object allOf: – #/definitions/abastecimento description: Entidade abastecimento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/pecaExternaOrdemServicoCreated: post: description: Evento de criação de uma peça externa da ordem de serviço x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – pecaExternaOrdemServico properties: pecaExternaOrdemServico: type: object allOf: – #/definitions/pecaExternaOrdemServico description: Entidade peça externa da ordem de serviço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/pecaExternaOrdemServicoUpdated: post: description: Evento de atualização de uma peça externa da ordem de serviço x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – pecaExternaOrdemServico properties: pecaExternaOrdemServico: type: object allOf: – #/definitions/pecaExternaOrdemServico description: Entidade peça externa da ordem de serviço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/servicoExternoOrdemServicoCreated: post: description: Evento de criação de um serviço externo da ordem de serviço x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – servicoExternoOrdemServico properties: servicoExternoOrdemServico: type: object allOf: – #/definitions/servicoExternoOrdemServico description: Entidade serviço externo da ordem de serviço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/servicoExternoOrdemServicoUpdated: post: description: Evento de criação de um serviço externo da ordem de serviço x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – servicoExternoOrdemServico properties: servicoExternoOrdemServico: type: object allOf: – #/definitions/servicoExternoOrdemServico description: Entidade serviço externo da ordem de serviço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/telemetriaCreated: post: description: Evento de criação de telemetria x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – telemetria properties: telemetria: type: object allOf: – #/definitions/telemetria description: Entidade telemetria responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/telemetriaEventoCreated: post: description: Evento de criação de telemetria evento x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – telemetriaEvento properties: telemetriaEvento: type: object allOf: – #/definitions/telemetriaEvento description: Entidade TelemetriaEvento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/funcionarioCreated: post: description: Evento de criação de funcionário x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – matricula – cracha – codigo properties: matricula: type: integer format: int64 description: Matrícula do funcionário cracha: type: string maxLength: 255 description: Crachá do funcionário codigo: type: integer format: int64 description: Código do funcionário responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/funcionarioUpdated: post: description: Evento de alteração no cadastro de funcionário x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – matricula – cracha – codigo properties: matricula: type: integer format: int64 description: Matrícula do funcionário cracha: type: string maxLength: 255 description: Crachá do funcionário codigo: type: integer format: int64 description: Código do funcionário responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/veiculoUpdated: post: description: Evento de alteração no cadastro de veículos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – placa properties: placa: type: string maxLength: 255 description: Placa do veículo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/importAbastecimentoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/exportAbastecimentoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/importTelemetriaEventoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/exportTelemetriaEventoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/importEventoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/exportEventoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/importTelemetriaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/exportTelemetriaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/importServicoExternoOrdemServicoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/exportServicoExternoOrdemServicoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/importPecaExternaOrdemServicoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/events/exportPecaExternaOrdemServicoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /frotas/apis/abastecimento: post: description: Fachada Abastecimento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/abastecimentoFacadeInput responses: 200: description: Ok schema: #/definitions/abastecimentoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Fachada Abastecimento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/abastecimentoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/abastecimentoCartaoVeiculo: get: description: Fachada Cartão Abastecimento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/abastecimentoCartaoVeiculoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/telemetriaEvento: post: description: Telemetria – Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/telemetriaEventoFacadeInput responses: 200: description: Ok schema: #/definitions/telemetriaEventoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Telemetria – Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/telemetriaEventoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/telemetria: post: description: Telemetria – Posições do veículo tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/telemetriaFacadeInput responses: 200: description: Ok schema: #/definitions/telemetriaFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Telemetria – Posições do veículo tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/telemetriaFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/veiculosLiberadosMotorista: get: description: Veículos liberados por motorista tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/veiculosLiberadosMotoristaFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/veiculosLiberadosMotoristaTelemetria: get: description: Telemetria – Veículos liberados por motorista tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/veiculosLiberadosMotoristaTelemetriaFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/veiculosLiberadosMotoristaAbastecimento: get: description: Abastecimento – Veículos liberados por motorista tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/veiculosLiberadosMotoristaAbastecimentoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/situacaoOrdemServico: get: description: Consulta do cadastro de situações da ordem de serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/situacaoOrdemServicoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/servicoExternoOrdemServico: post: description: Serviços da ordem de serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/servicoExternoOrdemServicoFacadeInput responses: 200: description: Ok schema: #/definitions/servicoExternoOrdemServicoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Serviços da ordem de serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/servicoExternoOrdemServicoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/servicoExternoOrdemServico/{id}: put: description: Serviços da ordem de serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/servicoExternoOrdemServicoFacadeInput responses: 200: description: Ok schema: #/definitions/servicoExternoOrdemServicoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/pecaExternaOrdemServico: post: description: Peças da ordem de serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/pecaExternaOrdemServicoFacadeInput responses: 200: description: Ok schema: #/definitions/pecaExternaOrdemServicoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Peças da ordem de serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/pecaExternaOrdemServicoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/pecaExternaOrdemServico/{id}: put: description: Peças da ordem de serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/pecaExternaOrdemServicoFacadeInput responses: 200: description: Ok schema: #/definitions/pecaExternaOrdemServicoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/planoServico: get: description: Consulta do cadastro de serviços tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/planoServicoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/peca: get: description: Consulta do cadastro de Peças tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/pecaFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/funcionario: get: description: Fachada do Funcionário tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/funcionarioFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/ordemServico: get: description: Manutenção de veículos – ordem de serviço tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/ordemServicoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/veiculo: get: description: Fachada veículo tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/veiculoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/acidenteVeiculo: get: description: Fachada Acidente tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/acidenteVeiculoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /frotas/apis/veiculosDisponiveis: get: description: Fachada de veículos disponíveis tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/veiculosDisponiveisFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumUpDown: description: Enumeração do status do serviço – Up or down type: string enum: – UP – DOWN enumTipoItem: description: Enumeração do tipo do item type: string enum: – COMBUSTIVEL – OLEO_MOTOR – ARLA – OUTROS enumStatusAction: description: Enumeração do status de retorno de ações type: string enum: – OK – ERRO enumSituacaoCartao: description: Enumeração da situação do cartão type: string enum: – ATIVO – INATIVO – BLOQUEADO enumTipoCartao: description: Enumeração do tipo do cartão type: string enum: – FIXO – RESERVA enumSituacaoServico: description: Enumeração da situação do serviço type: string enum: – NAO_CONCLUIDO – CONCLUIDO – REVISADO – NAO_APLICADO enumPrioridadeServico: description: Enumeração da prioridade de serviço type: string enum: – PLANEJADA – BAIXA – MEDIA – ALTA – CRITICA enumTypeOrder: description: Enumeração para o tipo de ordenação type: string enum: – ASC – DESC enumSituacaoRegistroVeicular: description: Enumeração para Situação de Registro Veicular type: string enum: – QUITADO – ALIENADO – FINANCIADO – CONSORCIO – ARRENDADO – LOCADO 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 fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR recPageRequest: description: Define a paginação da query type: object required: – offset – size properties: offset: type: integer format: int64 description: Número da página minimum: 0 size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: description: Define o registro com os dados dos campos à serem ordenados type: object required: – field – order properties: field: type: string maxLength: 255 description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) recCheckData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string maxLength: 255 description: Nome do healthcheck status: type: string allOf: – #/definitions/enumUpDown description: Status do healthcheck recEvento: description: Evento da telemetria type: object required: – codigo – descricao properties: codigo: type: string maxLength: 255 description: Código do evento descricao: type: string maxLength: 255 description: Descrição do evento recDefeito: description: Dados do defeito type: object required: – sequencia – descricao – resolvido – pendencia properties: sequencia: type: integer format: int64 description: Sequência descricao: type: string maxLength: 255 description: Descrição resolvido: type: boolean description: Situação pendencia: type: object allOf: – #/definitions/recPendencia description: Pendencias recPendencia: description: Dados da pendência type: object required: – cdVeiculo – cdEmpresa – cdPendencia – cdAcidente properties: cdVeiculo: type: integer format: int64 description: Cógido do veículo cdEmpresa: type: integer format: int64 description: Código da empresa cdPendencia: type: integer format: int64 description: Código da pendência cdAcidente: type: integer format: int64 description: Código do acidente recSituacaoOrdemServico: description: Dados da situação da ordem de serviço type: object required: – codigo – descricao – apelido properties: codigo: type: integer format: int64 description: Código da situação descricao: type: string maxLength: 255 description: Descrição da situação apelido: type: string maxLength: 255 description: Apelido da situação recTipoOrdemServico: description: Dados do tipo da ordem de serviço type: object required: – codigo – descricao – apelido properties: codigo: type: integer format: int64 description: Código do tipo descricao: type: string maxLength: 255 description: Descrição do tipo apelido: type: string maxLength: 255 description: Apelido do tipo recTipoItem: description: Dados do tipo do item type: object required: – codigo – descricao properties: codigo: type: integer format: int64 description: Código descricao: type: string maxLength: 255 description: Descrição recUnidadeMedida: description: Dados da Unidade de medida type: object required: – codigo – descricao – valor properties: codigo: type: string maxLength: 255 description: Código descricao: type: string maxLength: 255 description: Descrição valor: type: number format: double description: Valor funcionarioCreatedDTO: description: Dados da matrícula do funcionário type: object required: – matricula – cracha – codigo properties: matricula: type: integer format: int64 description: Matrícula do funcionário cracha: type: string maxLength: 255 description: Crachá do funcionário codigo: type: integer format: int64 description: Código do funcionário ordemServicoInput: description: Dados do input da ordem de serviço type: object required: – codigoEmpresa – codigoOrdemServico – cnpjFornecedor – datainclusao properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoOrdemServico: type: integer format: int64 description: Código da ordem de serviço cnpjFornecedor: type: string maxLength: 18 description: CNPJ do fornecedor datainclusao: type: string format: date-time description: Data da inclusão da ordem de serviço veiculoPlaca: description: Dados do input do Veículo type: object required: – placa properties: placa: type: string maxLength: 255 description: Placa do veículo abastecimento: description: Abastecimento type: object required: – placa – dataAbastecimento – hodometro – cpfMotorista – cnpjFornecedor – cnpjOperadora – nomeOperadora – codigoItem – quantidadeItem – valorTotal properties: id: type: string format: uuid description: Id da entidade placa: type: string maxLength: 255 description: Placa do veículo dataAbastecimento: type: string format: date-time description: Data e hora do abastecimento hodometro: type: number format: double description: Número do hodometro cpfMotorista: type: string maxLength: 255 description: CPF do motorista cnpjFornecedor: type: string maxLength: 255 description: CNPJ fornecedor cnpjOperadora: type: string maxLength: 255 description: CNPJ da Operadora de Cartão nomeOperadora: type: string maxLength: 255 description: Nome da Operadora codigoItem: type: string maxLength: 255 description: Código identificador do Item quantidadeItem: type: number format: double description: Quantidade do item valorTotal: type: number format: double description: Valor total valorDesconto: type: number format: double description: Valor do Desconto numeroDocumento: type: string maxLength: 255 description: Número do documento fiscal serieDocumento: type: string maxLength: 255 description: Serie do documento fiscal numeroCartao: type: string maxLength: 255 description: Número do cartão de abastecimento createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: telemetriaEvento: description: Telemetria – Eventos do veículo type: object required: – placa – latitude – longitude – dataPosicao properties: id: type: string format: uuid description: Id da entidade placa: type: string maxLength: 255 description: Placa do veículo latitude: type: string maxLength: 255 description: Latitude longitude: type: string maxLength: 255 description: Longitude dataPosicao: type: string format: date-time description: Data e hora da posição hodometro: type: number format: double description: Número do hodômetro cpfMotorista: type: string maxLength: 255 description: CPF do motorista pais: type: string maxLength: 255 description: Nome do pais uf: type: string maxLength: 255 description: Sigla do estado cidade: type: string maxLength: 255 description: Nome da cidade bairro: type: string maxLength: 255 description: Nome do bairro cep: type: string maxLength: 255 description: Número do CEP rua: type: string maxLength: 255 description: Nome da rua velocidade: type: number format: double description: Velocidade rpm: type: number format: double description: RPM eventos: type: array items: type: object allOf: – #/definitions/evento description: Lista de eventos createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: evento: description: Telemetria – Evento type: object required: – id properties: id: type: string format: uuid description: Id da entidade codigoEvento: type: string maxLength: 50 description: Código do cadastro do evento descricao: type: string maxLength: 255 description: Descrição do evento telemetriaEvento: type: object allOf: – #/definitions/telemetriaEvento description: Telemetria createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: telemetria: description: Telemetria – Posições do veículo type: object required: – placa – latitude – longitude – dataPosicao properties: id: type: string format: uuid description: Id da entidade placa: type: string maxLength: 255 description: Placa do veículo latitude: type: string maxLength: 255 description: Latitude longitude: type: string maxLength: 255 description: Longitude dataPosicao: type: string format: date-time description: Data e hora da posição hodometro: type: number format: double description: Número do hodômetro velocidade: type: number format: double description: Velocidade rpm: type: number format: double description: RPM cpfMotorista: type: string maxLength: 255 description: CPF do motorista pais: type: string maxLength: 255 description: Nome do pais uf: type: string maxLength: 255 description: Sigla do estado cidade: type: string maxLength: 255 description: Nome da cidade bairro: type: string maxLength: 255 description: Nome do bairro cep: type: string maxLength: 255 description: Número do CEP rua: type: string maxLength: 255 description: Nome da rua createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: servicoExternoOrdemServico: description: type: object required: – codigoEmpresa – codigoOrdemServico – sequencia – codigoPlanoServico properties: id: type: string format: uuid description: Id da entidade codigoEmpresa: type: integer format: int64 description: Código da empresa codigoOrdemServico: type: integer format: int64 description: Código da Ordem de Serviço sequencia: type: integer format: int64 description: Sequência cnpjFornecedor: type: string maxLength: 255 description: CNPJ do fornecedor dataExecucao: type: string format: date-time description: Data de execução codigoPlanoServico: type: integer format: int64 description: Código do Plano de Serviço codigoDefeito: type: integer format: int64 description: Código do defeito valorUnitario: type: number format: double description: Valor unitário valorTotal: type: number format: double description: Valor total observacao: type: string maxLength: 255 description: Observação concluido: type: boolean description: Serviço concluído numeroNotaFiscal: type: integer format: int64 description: Número da nota fiscal serieNotaFiscal: type: string maxLength: 255 description: Série da nota fiscal situacao: type: string allOf: – #/definitions/enumSituacaoServico description: Situação do Serviço dataGarantia: type: string format: date-time description: Data da garantia hodometro: type: number format: double description: Hodômetro valorDesconto: type: number format: double description: Valor do desconto dataExecucaoFinal: type: string format: date-time description: Data da execução final dataExecucaoInicial: type: string format: date-time description: Data da execução inicial createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time description: pecaExternaOrdemServico: description: Peças da Ordem de Serviço type: object required: – codigoEmpresa – codigoOrdemServico – sequencia properties: id: type: string format: uuid description: Id da entidade codigoEmpresa: type: integer format: int64 description: Código da empresa codigoOrdemServico: type: integer format: int64 description: Código da Ordem de Serviço sequencia: type: integer format: int64 description: Sequência cnpjFornecedor: type: string maxLength: 255 description: CNPJ do fornecedor dataUtilizacao: type: string format: date-time description: Data da utilização codigoItem: type: integer format: int64 description: Código do item quantidadeItem: type: number format: double description: Quantidade do item valorUnitario: type: number format: double description: Valor unitário valorTotal: type: number format: double description: Valor total observacao: type: string maxLength: 255 description: Observação numeroNotaFiscal: type: integer format: int64 description: Número da nota fiscal serieNotaFiscal: type: string maxLength: 255 description: Série da nota fiscal dataGarantia: type: string format: date-time description: Data da garantia hodometro: type: number format: double description: Hodômetro valorDesconto: type: number format: double description: Valor do desconto createdBy: type: string maxLength: 255 description: createdDate: type: string format: date-time description: lastModifiedBy: type: string maxLength: 255 description: lastModifiedDate: type: string format: date-time 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 maxLength: 255 description: Class of notification notificationOrigin: type: string maxLength: 255 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 maxLength: 255 description: Notification subject. notificationContent: type: string maxLength: 255 description: Notification content. sourceDomain: type: string maxLength: 255 description: Domain that generates the notification. sourceService: type: string maxLength: 255 description: Service that generates the notification. destinationUser: type: string maxLength: 255 description: Username of the destination user. link: type: string maxLength: 255 description: Notification link _discriminator: type: string maxLength: 255 description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string maxLength: 255 description: Email sender address sendTo: type: array items: type: string maxLength: 255 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 maxLength: 255 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string maxLength: 255 description: The domain the blob belongs to. serviceName: type: string maxLength: 255 description: The service the blob belongs to. targetObjectId: type: string maxLength: 255 description: The basic id of the blob. targetCopyId: type: string maxLength: 255 description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string maxLength: 255 description: The user-facing error message, if any. errorCode: type: string maxLength: 255 description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string maxLength: 255 description: message: type: string maxLength: 255 description: exceptionClass: type: string maxLength: 255 description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string maxLength: 255 description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string maxLength: 255 description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string maxLength: 255 description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string maxLength: 255 description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string maxLength: 255 description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string maxLength: 255 description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string maxLength: 255 description: beanClass: type: string maxLength: 255 description: serviceClass: type: string maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string maxLength: 255 description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string maxLength: 255 description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string maxLength: 255 description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string maxLength: 255 description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string maxLength: 255 description: Domain of the dependency service service: type: string maxLength: 255 description: Name of the dependency service type: string maxLength: 255 description: Version of the dependency service abastecimentoFacadeInput: description: Fachada Abastecimento type: object required: – placa – dataAbastecimento – hodometro – cpfMotorista – cnpjFornecedor – cnpjOperadora – nomeOperadora – codigoItem – quantidadeItem – valorTotal properties: placa: type: string maxLength: 255 description: Placa do veículo dataAbastecimento: type: string format: date-time description: Data e hora do abastecimento hodometro: type: number format: double description: Número do hodometro cpfMotorista: type: string maxLength: 255 description: CPF do motorista cnpjFornecedor: type: string maxLength: 255 description: CNPJ fornecedor cnpjOperadora: type: string maxLength: 255 description: CNPJ da Operadora de Cartão nomeOperadora: type: string maxLength: 255 description: Nome da Operadora codigoItem: type: string maxLength: 255 description: Código identificador do item quantidadeItem: type: number format: double description: Quantidade do item valorTotal: type: number format: double description: Valor total valorDesconto: type: number format: double description: Valor do Desconto numeroDocumento: type: string maxLength: 255 description: Número do documento fiscal serieDocumento: type: string maxLength: 255 description: Serie do documento fiscal numeroCartao: type: string maxLength: 255 description: Número do cartão de abastecimento abastecimentoFacadeOutput: description: Fachada Abastecimento type: object required: – placa – dataAbastecimento – hodometro – cpfMotorista – cnpjFornecedor – cnpjOperadora – nomeOperadora – codigoItem – tipoItem – quantidadeItem – valorTotal properties: placa: type: string maxLength: 255 description: Placa do veículo dataAbastecimento: type: string format: date-time description: Data e hora do abastecimento hodometro: type: number format: double description: Número do hodometro cpfMotorista: type: string maxLength: 255 description: CPF do motorista cnpjFornecedor: type: string maxLength: 255 description: CNPJ fornecedor cnpjOperadora: type: string maxLength: 255 description: CNPJ da Operadora de Cartão nomeOperadora: type: string maxLength: 255 description: Nome da Operadora codigoItem: type: string maxLength: 255 description: Código identificador do Item tipoItem: type: string allOf: – #/definitions/enumTipoItem description: Tipo do item quantidadeItem: type: number format: double description: Quantidade do item valorTotal: type: number format: double description: Valor total valorDesconto: type: number format: double description: Valor do Desconto numeroDocumento: type: string maxLength: 255 description: Número do documento fiscal serieDocumento: type: string maxLength: 255 description: Série do documento fiscal numeroCartao: type: string maxLength: 255 description: Número do cartão de abastecimento createdBy: type: string maxLength: 255 description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string maxLength: 255 description: Usuário última modificação lastModifiedDate: type: string format: date-time description: Data última modificação abastecimentoCartaoVeiculoFacadeInput: description: Fachada Cartão Abastecimento type: object required: – placa properties: codigoCartao: type: integer format: int64 description: Código do cartão codigoVeiculo: type: integer format: int64 description: Código do veículo numeroCartao: type: string maxLength: 255 description: Número do cartão dataVinculacao: type: string format: date-time description: Data da vinculação placa: type: string maxLength: 255 description: Placa do veículo abastecimentoCartaoVeiculoFacadeOutput: description: Fachada Cartão Abastecimento type: object required: – codigoCartao – codigoVeiculo – numeroCartao – placa – situacaoCartao – tipoCartao – dataVinculacao – vinculacaoAtiva properties: codigoCartao: type: integer format: int64 description: Código do cartão codigoVeiculo: type: integer format: int64 description: Código do veículo numeroCartao: type: string maxLength: 255 description: Número do cartão placa: type: string maxLength: 255 description: Placa do veículo situacaoCartao: type: string allOf: – #/definitions/enumSituacaoCartao description: Situação do cartão tipoCartao: type: string allOf: – #/definitions/enumTipoCartao description: Tipo do cartão dataVinculacao: type: string format: date-time description: Data da vinculação vinculacaoAtiva: type: boolean description: Situação da vinculação telemetriaEventoFacadeInput: description: Telemetria – Evento type: object required: – placa – latitude – longitude – dataPosicao properties: placa: type: string maxLength: 255 description: Placa do veículo latitude: type: string maxLength: 255 description: Latitude longitude: type: string maxLength: 255 description: Longitude dataPosicao: type: string format: date-time description: Data e hora da posição hodometro: type: number format: double description: Número do hodômetro cpfMotorista: type: string maxLength: 255 description: CPF do motorista pais: type: string maxLength: 255 description: Nome do pais uf: type: string maxLength: 255 description: Sigla do estado cidade: type: string maxLength: 255 description: Nome da cidade bairro: type: string maxLength: 255 description: Nome do bairro cep: type: string maxLength: 255 description: Número do CEP rua: type: string maxLength: 255 description: Nome da rua velocidade: type: number format: double description: Velocidade rpm: type: number format: double description: RPM eventos: type: array items: type: object allOf: – #/definitions/recEvento description: Lista de eventos telemetriaEventoFacadeOutput: description: Telemetria – Evento type: object required: – placa – latitude – longitude – dataPosicao – hodometro – cpfMotorista – pais – uf – cidade – bairro – cep – rua – velocidade – rpm properties: placa: type: string maxLength: 255 description: Placa do veículo latitude: type: string maxLength: 255 description: Latitude longitude: type: string maxLength: 255 description: Longitude dataPosicao: type: string format: date-time description: Data e hora da posição hodometro: type: number format: double description: Número do hodômetro cpfMotorista: type: string maxLength: 255 description: CPF do motorista pais: type: string maxLength: 255 description: Nome do pais uf: type: string maxLength: 255 description: Sigla do estado cidade: type: string maxLength: 255 description: Nome da cidade bairro: type: string maxLength: 255 description: Nome do bairro cep: type: string maxLength: 255 description: Número do CEP rua: type: string maxLength: 255 description: Nome da rua velocidade: type: number format: double description: Velocidade rpm: type: number format: double description: RPM eventos: type: array items: type: object allOf: – #/definitions/recEvento description: Lista de eventos createdBy: type: string maxLength: 255 description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string maxLength: 255 description: Usuário última modificação lastModifiedDate: type: string format: date-time description: Data última modificação telemetriaFacadeInput: description: Telemetria – Posições do veículo type: object required: – placa – latitude – longitude – dataPosicao properties: placa: type: string maxLength: 255 description: Placa do veículo latitude: type: string maxLength: 255 description: Latitude longitude: type: string maxLength: 255 description: Longitude dataPosicao: type: string format: date-time description: Data e hora da posição hodometro: type: number format: double description: Número do hodômetro velocidade: type: number format: double description: Velocidade rpm: type: number format: double description: RPM cpfMotorista: type: string maxLength: 255 description: CPF do motorista pais: type: string maxLength: 255 description: Nome do pais uf: type: string maxLength: 255 description: Sigla do estado cidade: type: string maxLength: 255 description: Nome da cidade bairro: type: string maxLength: 255 description: Nome do bairro cep: type: string maxLength: 255 description: Número do CEP rua: type: string maxLength: 255 description: Nome da rua telemetriaFacadeOutput: description: Telemetria – Posições do veículo type: object required: – placa – latitude – longitude – dataPosicao properties: placa: type: string maxLength: 255 description: Placa do veículo latitude: type: string maxLength: 255 description: Latitude longitude: type: string maxLength: 255 description: Longitude dataPosicao: type: string format: date-time description: Data e hora da posição hodometro: type: number format: double description: Número do hodômetro velocidade: type: number format: double description: Velocidade rpm: type: number format: double description: RPM cpfMotorista: type: string maxLength: 255 description: CPF do motorista pais: type: string maxLength: 255 description: Nome do pais uf: type: string maxLength: 255 description: Sigla do estado cidade: type: string maxLength: 255 description: Nome da cidade bairro: type: string maxLength: 255 description: Nome do bairro cep: type: string maxLength: 255 description: Número do CEP rua: type: string maxLength: 255 description: Nome da rua veiculosLiberadosMotoristaFacadeInput: description: Veículos liberados por motorista type: object required: – matricula – cracha – cpfMotorista – codigoEmpresaMotorista – nomeEmpresaMotorista – placa – codigoVeiculo – codigoTipoVeiculo – descricaoTipoVeiculo – apelidoTipoVeiculo – codigoEmpresaVeiculo – nomeEmpresaVeiculo – cnpjRegistroVeicular properties: matricula: type: integer format: int64 description: Matrícula do motorista cracha: type: string maxLength: 255 description: Crachá do motorista cpfMotorista: type: string maxLength: 255 description: CPF do motorista codigoEmpresaMotorista: type: integer format: int64 description: Código da empresa do motorista nomeEmpresaMotorista: type: string maxLength: 255 description: Nome da empresa do motorista placa: type: string maxLength: 255 description: Placa do veículo codigoVeiculo: type: integer format: int64 description: Código do veículo codigoTipoVeiculo: type: integer format: int64 description: Código do tipo de veículo descricaoTipoVeiculo: type: string maxLength: 255 description: Descrição do tipo de veículo apelidoTipoVeiculo: type: string maxLength: 255 description: Apelido do tipo de veículo codigoEmpresaVeiculo: type: integer format: int64 description: Código da empresa do veículo nomeEmpresaVeiculo: type: string maxLength: 255 description: Nome da Empresa do veículo cnpjRegistroVeicular: type: string maxLength: 255 description: CNPJ do fornecedor do registro veicular veiculosLiberadosMotoristaFacadeOutput: description: Veículos liberados por motorista type: object required: – matricula – nome – cracha – cpfMotorista – codigoEmpresaMotorista – nomeEmpresaMotorista – placa – codigoVeiculo – numeroVeiculo – codigoTipoVeiculo – descricaoTipoVeiculo – apelidoTipoVeiculo – codigoEmpresaVeiculo – nomeEmpresaVeiculo – codigoRegistroVeicular – nomeRegistroVeicular – cnpjRegistroVeicular – situacaoRegistroVeicular properties: matricula: type: integer format: int64 description: Matrícula do motorista nome: type: string maxLength: 255 description: Nome do motorista cracha: type: string maxLength: 255 description: Crachá do motorista cpfMotorista: type: string maxLength: 255 description: CPF do motorista codigoEmpresaMotorista: type: integer format: int64 description: Código da empresa do motorista nomeEmpresaMotorista: type: string maxLength: 255 description: Nome da empresa do motorista placa: type: string maxLength: 255 description: Placa do veículo codigoVeiculo: type: integer format: int64 description: Código do veículo numeroVeiculo: type: string maxLength: 255 description: Número do veículo codigoTipoVeiculo: type: integer format: int64 description: Código do tipo de veículo descricaoTipoVeiculo: type: string maxLength: 255 description: Descrição do tipo de veículo apelidoTipoVeiculo: type: string maxLength: 255 description: Apelido do tipo de veículo codigoEmpresaVeiculo: type: integer format: int64 description: Código da empresa do veículo nomeEmpresaVeiculo: type: string maxLength: 255 description: Nome da empresa do veículo codigoRegistroVeicular: type: string maxLength: 255 description: Código do fornecedor do registro veicular nomeRegistroVeicular: type: string maxLength: 255 description: Nome do fornecedor do registro veicular cnpjRegistroVeicular: type: string maxLength: 255 description: CNPJ do fornecedor do registro veicular situacaoRegistroVeicular: type: string allOf: – #/definitions/enumSituacaoRegistroVeicular description: Situação do registro veicular veiculosLiberadosMotoristaTelemetriaFacadeInput: description: Telemetria – Veículos liberados por motorista type: object required: – matricula – cracha – cpfMotorista – codigoEmpresaMotorista – nomeEmpresaMotorista – placa – codigoVeiculo – codigoTipoVeiculo – descricaoTipoVeiculo – apelidoTipoVeiculo – codigoEmpresaVeiculo – nomeEmpresaVeiculo – cnpjRegistroVeicular properties: matricula: type: integer format: int64 description: Matrícula do motorista cracha: type: string maxLength: 255 description: Crachá do motorista cpfMotorista: type: string maxLength: 255 description: CPF do motorista codigoEmpresaMotorista: type: integer format: int64 description: Código da empresa do motorista nomeEmpresaMotorista: type: string maxLength: 255 description: Nome da empresa do motorista placa: type: string maxLength: 255 description: Placa do veículo codigoVeiculo: type: integer format: int64 description: Código do veículo codigoTipoVeiculo: type: integer format: int64 description: Código do tipo de veículo descricaoTipoVeiculo: type: string maxLength: 255 description: Descrição do tipo de veículo apelidoTipoVeiculo: type: string maxLength: 255 description: Apelido do tipo de veículo codigoEmpresaVeiculo: type: integer format: int64 description: Código da empresa do veículo nomeEmpresaVeiculo: type: string maxLength: 255 description: Nome da empresa do veículo cnpjRegistroVeicular: type: string maxLength: 255 description: CNPJ do fornecedor do registro veicular veiculosLiberadosMotoristaTelemetriaFacadeOutput: description: Telemetria – Veículos liberados por motorista type: object required: – matricula – cracha – cpfMotorista – nomeMotorista – codigoEmpresaMotorista – nomeEmpresaMotorista – placa – codigoVeiculo – numeroVeiculo – codigoTipoVeiculo – descricaoTipoVeiculo – apelidoTipoVeiculo – codigoEmpresaVeiculo – nomeEmpresaVeiculo – cnpjRegistroVeicular – situacaoRegistroVeicular – codigoFabricanteRastreador – descricaoFabricanteRastreador properties: matricula: type: integer format: int64 description: Matrícula do motorista cracha: type: string maxLength: 255 description: Crachá do motorista cpfMotorista: type: string maxLength: 255 description: CPF do motorista nomeMotorista: type: string maxLength: 255 description: Nome do motorista codigoEmpresaMotorista: type: integer format: int64 description: Código da empresa do motorista nomeEmpresaMotorista: type: string maxLength: 255 description: Nome da empresa do motorista placa: type: string maxLength: 255 description: Placa do veículo codigoVeiculo: type: integer format: int64 description: Código do veículo numeroVeiculo: type: string maxLength: 255 description: Número do veículo codigoTipoVeiculo: type: integer format: int64 description: Código do tipo de veículo descricaoTipoVeiculo: type: string maxLength: 255 description: Descrição do tipo de veículo apelidoTipoVeiculo: type: string maxLength: 255 description: Apelido do tipo de veículo codigoEmpresaVeiculo: type: integer format: int64 description: Código da empresa do veículo nomeEmpresaVeiculo: type: string maxLength: 255 description: Nome da empresa do veículo cnpjRegistroVeicular: type: string maxLength: 255 description: CNPJ do fornecedor do registro veicular situacaoRegistroVeicular: type: string allOf: – #/definitions/enumSituacaoRegistroVeicular description: Situação registro veicular codigoFabricanteRastreador: type: integer format: int64 description: Código do fabricante rastreador descricaoFabricanteRastreador: type: string maxLength: 255 description: Descricao do fabricante rastreador veiculosLiberadosMotoristaAbastecimentoFacadeInput: description: Abastecimento – Veículos liberados por motorista type: object required: – matricula – cracha – cpfMotorista – codigoEmpresaMotorista – nomeEmpresaMotorista – placa – codigoVeiculo – codigoTipoVeiculo – descricaoTipoVeiculo – apelidoTipoVeiculo – codigoEmpresaVeiculo – nomeEmpresaVeiculo – cnpjRegistroVeicular properties: matricula: type: integer format: int64 description: Matrícula do motorista cracha: type: string maxLength: 255 description: Crachá do motorista cpfMotorista: type: string maxLength: 255 description: CPF do motorista codigoEmpresaMotorista: type: integer format: int64 description: Código da empresa do motorista nomeEmpresaMotorista: type: string maxLength: 255 description: Nome da empresa do motorista placa: type: string maxLength: 255 description: Placa do veículo codigoVeiculo: type: integer format: int64 description: Código do veículo codigoTipoVeiculo: type: integer format: int64 description: Código do tipo de veículo descricaoTipoVeiculo: type: string maxLength: 255 description: Descrição do tipo de veículo apelidoTipoVeiculo: type: string maxLength: 255 description: Apelido do tipo de veículo codigoEmpresaVeiculo: type: integer format: int64 description: Código da empresa do veículo nomeEmpresaVeiculo: type: string maxLength: 255 description: Nome da empresa do veículo cnpjRegistroVeicular: type: string maxLength: 255 description: CNPJ do fornecedor do registro veicular veiculosLiberadosMotoristaAbastecimentoFacadeOutput: description: Abastecimento – Veículos liberados por motorista type: object required: – matricula – cracha – cpfMotorista – nomeMotorista – codigoEmpresaMotorista – nomeEmpresaMotorista – placa – codigoVeiculo – numeroVeiculo – codigoTipoVeiculo – descricaoTipoVeiculo – apelidoTipoVeiculo – codigoEmpresaVeiculo – nomeEmpresaVeiculo – cnpjRegistroVeicular – situacaoRegistroVeicular – cnpjFornecedorAbastecimento – nomeFornecedorAbastecimento properties: matricula: type: integer format: int64 description: Matrícula do motorista cracha: type: string maxLength: 255 description: Crachá do motorista cpfMotorista: type: string maxLength: 255 description: CPF do motorista nomeMotorista: type: string maxLength: 255 description: Nome do motorista codigoEmpresaMotorista: type: integer format: int64 description: Código da empresa do motorista nomeEmpresaMotorista: type: string maxLength: 255 description: Nome da empresa do motorista placa: type: string maxLength: 255 description: Placa do veículo codigoVeiculo: type: integer format: int64 description: Código do veículo numeroVeiculo: type: string maxLength: 255 description: Número do veículo codigoTipoVeiculo: type: integer format: int64 description: Código do tipo de veículo descricaoTipoVeiculo: type: string maxLength: 255 description: Descrição do tipo de veículo apelidoTipoVeiculo: type: string maxLength: 255 description: Apelido do tipo de veículo codigoEmpresaVeiculo: type: integer format: int64 description: Código da empresa do veículo nomeEmpresaVeiculo: type: string maxLength: 255 description: Nome da empresa do veículo cnpjRegistroVeicular: type: string maxLength: 255 description: CNPJ do fornecedor do registro veicular situacaoRegistroVeicular: type: string allOf: – #/definitions/enumSituacaoRegistroVeicular description: Situação registro veicular cnpjFornecedorAbastecimento: type: string maxLength: 255 description: CNPJ do fornecedor de abastecimento nomeFornecedorAbastecimento: type: string maxLength: 255 description: Nome do fornecedor de abastecimento situacaoOrdemServicoFacadeInput: description: Consulta do cadastro de situações da ordem de serviço type: object properties: codigo: type: integer format: int64 description: Código da situação descricao: type: string maxLength: 255 description: Descrição apelido: type: string maxLength: 255 description: Apelido situacaoOrdemServicoFacadeOutput: description: Consulta do cadastro de situações da ordem de serviço type: object required: – codigo – descricao – apelido properties: codigo: type: integer format: int64 description: Código da situação descricao: type: string maxLength: 255 description: Descrição apelido: type: string maxLength: 255 description: Apelido servicoExternoOrdemServicoFacadeInput: description: Serviços da ordem de serviço type: object required: – codigoEmpresa – codigoOrdemServico – sequencia – codigoPlanoServico properties: id: type: string format: uuid description: Id da entidade codigoEmpresa: type: integer format: int64 description: Código da empresa codigoOrdemServico: type: integer format: int64 description: Código da ordem de serviço sequencia: type: integer format: int64 description: Sequência cnpjFornecedor: type: string maxLength: 255 description: CNPJ do fornecedor dataExecucao: type: string format: date-time description: Data de execução codigoPlanoServico: type: integer format: int64 description: Código do plano de serviço codigoDefeito: type: integer format: int64 description: Código do defeito valorUnitario: type: number format: double description: Valor unitário valorTotal: type: number format: double description: Valor total observacao: type: string maxLength: 255 description: Observação concluido: type: boolean description: Serviço concluído numeroNotaFiscal: type: integer format: int64 description: Número da nota fiscal serieNotaFiscal: type: string maxLength: 255 description: Série da nota fiscal situacao: type: string allOf: – #/definitions/enumSituacaoServico description: Situação do Serviço dataGarantia: type: string format: date-time description: Data da garantia hodometro: type: number format: double description: Hodômetro valorDesconto: type: number format: double description: Valor do desconto dataExecucaoFinal: type: string format: date-time description: Data da execução final dataExecucaoInicial: type: string format: date-time description: Data da execução inicial servicoExternoOrdemServicoFacadeOutput: description: Serviços da ordem de serviço type: object required: – codigoEmpresa – codigoOrdemServico – sequencia – cnpjFornecedor – dataExecucao – codigoPlanoServico – valorUnitario – valorTotal – observacao – concluido – numeroNotaFiscal – serieNotaFiscal – situacao – dataGarantia – hodometro – valorDesconto – dataExecucaoFinal – dataExecucaoInicial – createdBy – createdDate – lastModifiedBy – lastModifiedDate properties: id: type: string maxLength: 255 description: Id da entidade codigoEmpresa: type: integer format: int64 description: Código da empresa codigoOrdemServico: type: integer format: int64 description: Código da ordem de serviço sequencia: type: integer format: int64 description: Sequência cnpjFornecedor: type: string maxLength: 255 description: CNPJ do fornecedor dataExecucao: type: string format: date-time description: Data de execução codigoPlanoServico: type: integer format: int64 description: Código do plano de serviço codigoDefeito: type: integer format: int64 description: Código do defeito valorUnitario: type: number format: double description: Valor unitário valorTotal: type: number format: double description: Valor total observacao: type: string maxLength: 255 description: Observação concluido: type: boolean description: Serviço concluído numeroNotaFiscal: type: integer format: int64 description: Número da nota fiscal serieNotaFiscal: type: string maxLength: 255 description: Série da nota fiscal situacao: type: string allOf: – #/definitions/enumSituacaoServico description: Situação do serviço dataGarantia: type: string format: date-time description: Data da garantia hodometro: type: number format: double description: Hodômetro valorDesconto: type: number format: double description: Valor do desconto dataExecucaoFinal: type: string format: date-time description: Data da execução final dataExecucaoInicial: type: string format: date-time description: Data da execução inicial createdBy: type: string maxLength: 255 description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string maxLength: 255 description: Usuário última modificação lastModifiedDate: type: string format: date-time description: Data última modificação pecaExternaOrdemServicoFacadeInput: description: Peças da ordem de serviço type: object required: – codigoEmpresa – codigoOrdemServico – sequencia – codigoItem properties: id: type: string format: uuid description: Id da entidade codigoEmpresa: type: integer format: int64 description: Código da empresa codigoOrdemServico: type: integer format: int64 description: Código da ordem de serviço sequencia: type: integer format: int64 description: Sequência cnpjFornecedor: type: string maxLength: 255 description: CNPJ do fornecedor dataUtilizacao: type: string format: date-time description: Data da utilização codigoItem: type: integer format: int64 description: Código do item quantidadeItem: type: number format: double description: Quantidade do item valorUnitario: type: number format: double description: Valor unitário valorTotal: type: number format: double description: Valor total observacao: type: string maxLength: 255 description: Observação numeroNotaFiscal: type: integer format: int64 description: Número da nota fiscal serieNotaFiscal: type: string maxLength: 255 description: Série da nota fiscal dataGarantia: type: string format: date-time description: Data da garantia hodometro: type: number format: double description: Hodômetro valorDesconto: type: number format: double description: Valor do desconto pecaExternaOrdemServicoFacadeOutput: description: Peças da ordem de serviço type: object required: – codigoEmpresa – codigoOrdemServico – sequencia – cnpjFornecedor – dataUtilizacao – codigoItem – quantidadeItem – valorUnitario – valorTotal – observacao – numeroNotaFiscal – serieNotaFiscal – dataGarantia – hodometro – valorDesconto – createdBy – createdDate – lastModifiedBy – lastModifiedDate properties: id: type: string maxLength: 255 description: Id da entidade codigoEmpresa: type: integer format: int64 description: Código da empresa codigoOrdemServico: type: integer format: int64 description: Código da ordem de serviço sequencia: type: integer format: int64 description: Sequência cnpjFornecedor: type: string maxLength: 255 description: CNPJ do fornecedor dataUtilizacao: type: string format: date-time description: Data da utilização codigoItem: type: integer format: int64 description: Código do item quantidadeItem: type: number format: double description: Quantidade do item valorUnitario: type: number format: double description: Valor unitário valorTotal: type: number format: double description: Valor total observacao: type: string maxLength: 255 description: Observação numeroNotaFiscal: type: integer format: int64 description: Número da nota fiscal serieNotaFiscal: type: string maxLength: 255 description: Série da nota fiscal dataGarantia: type: string format: date-time description: Data da garantia hodometro: type: number format: double description: Hodômetro valorDesconto: type: number format: double description: Valor do desconto createdBy: type: string maxLength: 255 description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string maxLength: 255 description: Usuário última modificação lastModifiedDate: type: string format: date-time description: Data última modificação planoServicoFacadeInput: description: Consulta do cadastro de serviços type: object properties: codigo: type: integer format: int64 description: Código do plano de serviço numero: type: string maxLength: 255 description: Número do plano de serviço descricao: type: string maxLength: 255 description: Descrição do plano de serviço apelido: type: string maxLength: 255 description: Apelido numeroNivel: type: integer format: int64 description: Número do nível do plano servicoBorracharia: type: boolean description: Serviço de borracharia planoServicoFacadeOutput: description: Consulta do cadastro de serviços type: object required: – codigo – numero – descricao – apelido – numeroNivel – diasGarantia – diasReservico – horasPadraoServico – servicoBorracharia – prioridade properties: codigo: type: integer format: int64 description: Código do plano de serviço numero: type: string maxLength: 255 description: Número do plano de serviço descricao: type: string maxLength: 255 description: Descrição do plano de serviço apelido: type: string maxLength: 255 description: Apelido numeroNivel: type: integer format: int64 description: Número do nível do plano diasGarantia: type: integer format: int64 description: Quantidade de dias de garantia diasReservico: type: integer format: int64 description: Quantidade de dias para reserviço horasPadraoServico: type: number format: double description: Quantidade de horas para a realização do serviço servicoBorracharia: type: boolean description: Serviço de borracharia prioridade: type: string allOf: – #/definitions/enumPrioridadeServico description: Prioridade do serviço pecaFacadeInput: description: Consulta do cadastro de Peças type: object required: – codigo – numero – descricao – codigoTipoItem – numeroItemFornecedor – inativo properties: codigo: type: integer format: int64 description: Código numero: type: string maxLength: 255 description: Número descricao: type: string maxLength: 255 description: Descrição codigoTipoItem: type: integer format: int64 description: Código do tipo do item numeroItemFornecedor: type: string maxLength: 255 description: Número do item do fornecedor inativo: type: boolean description: Peça inativa pecaFacadeOutput: description: Consulta do cadastro de Peças type: object required: – codigo – numero – descricao – tipoItem – unidadeMedida – pesoLiquido – observacao – numeroItemFornecedor – numeroCor – inativo – peso – largura – altura – comprimento – kmGarantia – prazoGarantia properties: codigo: type: integer format: int64 description: Código numero: type: string maxLength: 255 description: Número descricao: type: string maxLength: 255 description: Descrição tipoItem: type: object allOf: – #/definitions/recTipoItem description: Tipo do item unidadeMedida: type: object allOf: – #/definitions/recUnidadeMedida description: Unidade de medida pesoLiquido: type: number format: double description: Peso líquido observacao: type: string maxLength: 255 description: Observação numeroItemFornecedor: type: string maxLength: 255 description: Número do item do fornecedor numeroCor: type: integer format: int64 description: Número da cor inativo: type: boolean description: Peça inativa peso: type: number format: double description: Peso largura: type: number format: double description: Largura altura: type: number format: double description: Altura comprimento: type: number format: double description: Comprimento kmGarantia: type: integer format: int64 description: Quilômetros de garantia prazoGarantia: type: integer format: int64 description: Prazo de garantia funcionarioFacadeInput: description: Fachada do Funcionário type: object properties: codigo: type: integer format: int64 description: Código do funcionário nome: type: string maxLength: 255 description: Nome do funcionário matricula: type: string maxLength: 255 description: Matrícula do funcionário cpf: type: string maxLength: 255 description: CPF do funcionário demitido: type: boolean description: Funcionário Demitido codigoEmpresa: type: integer format: int64 description: Código da empresa do funcionário funcionarioFacadeOutput: description: Fachada do Funcionário type: object required: – codigo – nome – matricula – numeroCracha – cpf – email – demitido properties: codigo: type: integer format: int64 description: Código do Funcionário nome: type: string maxLength: 255 description: Nome do funcionário matricula: type: string maxLength: 255 description: Matrícula do funcionário numeroCracha: type: string maxLength: 255 description: Número do Crachá cpf: type: string maxLength: 255 description: CPF do funcionário email: type: string maxLength: 255 description: Email do funcionário demitido: type: boolean description: Funcionário Demitido codigoEmpresa: type: integer format: int64 description: Código da empresa do funcionário nomeEmpresa: type: string maxLength: 255 description: Nome da empresa do funcionário apelidoEmpresa: type: string maxLength: 255 description: Apelido da empresa do funcionário ordemServicoFacadeInput: description: Manutenção de veículos – ordem de serviço type: object properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoOrdemServico: type: integer format: int64 description: Código da Ordem de Serviço codigoVeiculo: type: integer format: int64 description: Código do veículo placa: type: string maxLength: 255 description: Placa do veículo dataEmissao: type: string format: date-time description: Data de emissão cnpjFornecedor: type: string maxLength: 255 description: CNPJ do fornecedor dataConclusaoPrevista: type: string format: date-time description: Data da conclusão prevista codigoSituacao: type: integer format: int64 description: Código da situação impressa: type: boolean description: Ordem de serviço impressa dataBaixa: type: string format: date-time description: Data da baixa numeroProtocolo: type: string maxLength: 30 description: Número do protocolo de atendimento ordemServicoFacadeOutput: description: Manutenção de veículos – ordem de serviço type: object required: – codigoEmpresa – codigoOrdemServico – codigoVeiculo – placa – dataEmissao – cnpjFornecedor – hodometro – valorOrcado – dataConclusaoPrevista – descricaoDefeitos – tipo – situacao – defeitos – impressa – dataBaixa – codigoAcidente – numeroProtocolo properties: codigoEmpresa: type: integer format: int64 description: Código da empresa codigoOrdemServico: type: integer format: int64 description: Código da Ordem de Serviço codigoVeiculo: type: integer format: int64 description: Código do veículo placa: type: string maxLength: 255 description: Placa do veículo dataEmissao: type: string format: date-time description: Data de emissão cnpjFornecedor: type: string maxLength: 255 description: CNPJ do fornecedor hodometro: type: number format: double description: Hodômetro valorOrcado: type: number format: double description: Valor orçado dataConclusaoPrevista: type: string format: date-time description: Data da conclusão prevista descricaoDefeitos: type: string maxLength: 255 description: Descrição dos defeitos tipo: type: object allOf: – #/definitions/recTipoOrdemServico description: Tipo da Ordem de Serviço situacao: type: object allOf: – #/definitions/recSituacaoOrdemServico description: Situação da Ordem de serviço defeitos: type: array items: type: object allOf: – #/definitions/recDefeito minimum: 1 description: Defeitos impressa: type: boolean description: Ordem de serviço impressa dataBaixa: type: string format: date-time description: Data da baixa codigoAcidente: type: integer format: int64 description: Acidente principal numeroProtocolo: type: string maxLength: 30 description: Número do protocolo de atendimento veiculoFacadeInput: description: Fachada veículo type: object properties: codigo: type: integer format: int64 description: Código do veículo numero: type: string maxLength: 255 description: Número de identificação placa: type: string maxLength: 255 description: Placa do veículo codigoEmpresa: type: integer format: int64 description: Código da empresa do veículo ativo: type: boolean description: Veículo ativo veiculoFacadeOutput: description: Fachada veículo type: object required: – codigo – numero – placa – patrimonio – chassis – renavan – categoriaCrv – anoModelo – anoFabricacao – capacidadeTanque – codigoEixos – descricaoEixos – codigoModelo – descricaoModelo – apelidoModelo – codigoFabricante – descricaoFabricante – codigoCombustivel – descricaoCombustivel – codigoCor – descricaoCor – apelidoCor – codigoCentroCusto – descricaoCentroCusto – apelidoCentroCusto – codigoCentroCustoAlm – descricaoCentroCustoAlm – apelidoCentroCustoAlm – codigoCentroCustoFinAlm – descricaoCentroCustoFinAlm – apelidoCentroCustoFinAlm – codigoErpExtCentroCustoFinAlm – codigoEmpresaVeiculo – nomeEmpresaVeiculo – apelidoEmpresaVeiculo – codigoTipoVeiculo – descricaoTipoVeiculo – apelidoTipoVeiculo – codigoGrupoRequisito – descricaoGrupoRequisito – apelidoGrupoRequisito – codigoExtGrupoRequisito – cnpjRegistroVeicular – nomeRegistroVeicular – situacaoRegistroVeicular – numeroContratoRegistroVeicular – dataFinalRegistroVeicular – entradaFrotaCodigoTipo – entradaFrotaCodigoDescricao – entradaFrotaData – entradaFrotaValor – entradaFrotaFornecedorCodigo – entradaFrotaFornecedorNome – entradaFrotaObservacao – saidaFrotaCodigoTipo – saidaFrotaCodigoDescricao – saidaFrotaData – saidaFrotaValor – saidaFrotaClienteCodigo – saidaFrotaClienteNome – saidaFrotaObservacao – ativo – baixado properties: codigo: type: integer format: int64 description: Código do veículo numero: type: string maxLength: 255 description: Número de identificação placa: type: string maxLength: 255 description: Placa do veículo patrimonio: type: string maxLength: 255 description: Código do patrimonio do veículo chassis: type: string maxLength: 255 description: Número do chassis do veículo renavan: type: string maxLength: 255 description: Número do Renavan do veículo categoriaCrv: type: string maxLength: 255 description: Categoria do certificado do registro do veículo anoModelo: type: integer format: int64 description: Ano do modelo do veículo anoFabricacao: type: integer format: int64 description: Ano de fabricação do veículo capacidadeTanque: type: number format: double description: Capacidade do tanque do veículo codigoEixos: type: integer format: int64 description: Código dos eixos do veículo descricaoEixos: type: string maxLength: 255 description: Descrição dos eixos do veículo codigoModelo: type: integer format: int64 description: Código do modelo do veículo descricaoModelo: type: string maxLength: 255 description: Descrição do modelo do veículo apelidoModelo: type: string maxLength: 255 description: Apelido do modelo do veículo codigoFabricante: type: integer format: int64 description: Código do fabricante do veículo descricaoFabricante: type: string maxLength: 255 description: Descrição do fabricante do veículo codigoCombustivel: type: integer format: int64 description: Código do combustível do veículo descricaoCombustivel: type: string maxLength: 255 description: Descrição do combustível do veículo codigoCor: type: integer format: int64 description: Código da cor do veículo descricaoCor: type: string maxLength: 255 description: Descrição da cor do veículo apelidoCor: type: string maxLength: 255 description: Apelido da cor do veículo codigoCentroCusto: type: integer format: int64 description: Código do centro de custo do veículo descricaoCentroCusto: type: string maxLength: 255 description: Descrição do centro de custo do veículo apelidoCentroCusto: type: string maxLength: 255 description: Apelido do centro de custo do veículo codigoCentroCustoAlm: type: integer format: int64 description: Código do centro de custo almoxarifado do veículo descricaoCentroCustoAlm: type: string maxLength: 255 description: Descrição do centro de custo almoxarifado do veículo apelidoCentroCustoAlm: type: string maxLength: 255 description: Apelido do centro de custo almoxarifado do veículo codigoCentroCustoFinAlm: type: integer format: int64 description: Código do centro de custo financeiro almoxarifado do veículo descricaoCentroCustoFinAlm: type: string maxLength: 255 description: Descrição do centro de custo financeiro almoxarifado do veículo apelidoCentroCustoFinAlm: type: string maxLength: 255 description: Apelido do centro de custo financeiro almoxarifado do veículo codigoErpExtCentroCustoFinAlm: type: string maxLength: 255 description: Código ERP externo do centro de custo financeiro almoxarifado do veículo codigoEmpresaVeiculo: type: integer format: int64 description: Código da empresa do veículo nomeEmpresaVeiculo: type: string maxLength: 255 description: Nome da empresa do veículo apelidoEmpresaVeiculo: type: string maxLength: 255 description: Apelido da empresa do veículo codigoTipoVeiculo: type: integer format: int64 description: Código do tipo de veículo descricaoTipoVeiculo: type: string maxLength: 255 description: Descrição do tipo de veículo apelidoTipoVeiculo: type: string maxLength: 255 description: Apelido do tipo de veículo codigoGrupoRequisito: type: integer format: int64 description: Código do grupo de requisitos do veículo descricaoGrupoRequisito: type: string maxLength: 255 description: Descrição do grupo de requisitos do veículo apelidoGrupoRequisito: type: string maxLength: 255 description: Apelido do grupo de requisitos do veículo codigoExtGrupoRequisito: type: string maxLength: 255 description: Código externo do grupo de requisitos do veículo cnpjRegistroVeicular: type: string maxLength: 255 description: CNPJ do registro veicular nomeRegistroVeicular: type: string maxLength: 255 description: Nome do registro veicular situacaoRegistroVeicular: type: string allOf: – #/definitions/enumSituacaoRegistroVeicular description: Situação do registro veicular numeroContratoRegistroVeicular: type: string maxLength: 255 description: Número do contrato do registro veicular dataFinalRegistroVeicular: type: string format: date-time description: Data final do registro veicular entradaFrotaCodigoTipo: type: integer format: int64 description: Codigo do tipo da entrada na frota entradaFrotaCodigoDescricao: type: string maxLength: 255 description: Descrição do tipo da entrada na frota entradaFrotaData: type: string format: date-time description: Data de entrada na frota entradaFrotaValor: type: number format: double description: Valor de entrada na frota entradaFrotaFornecedorCodigo: type: string maxLength: 255 description: Código do fornecedor de entrada na frota entradaFrotaFornecedorNome: type: string maxLength: 255 description: Nome do fornecedor de entrada na frota entradaFrotaObservacao: type: string maxLength: 255 description: Observação de entrada na frota saidaFrotaCodigoTipo: type: integer format: int64 description: Codigo do tipo de saída da frota saidaFrotaCodigoDescricao: type: string maxLength: 255 description: Descrição do tipo da saída na frota saidaFrotaData: type: string format: date-time description: Data de saída da frota saidaFrotaValor: type: number format: double description: Valor de saída da frota saidaFrotaClienteCodigo: type: string maxLength: 255 description: Código do cliente de saída da frota saidaFrotaClienteNome: type: string maxLength: 255 description: Nome do cliente de saída da frota saidaFrotaObservacao: type: string maxLength: 255 description: Observação de saída da frota ativo: type: boolean description: Veículo ativo baixado: type: boolean description: Veículo baixado acidenteVeiculoFacadeInput: description: Fachada Acidente type: object required: – codigoAcidente properties: codigoAcidente: type: integer format: int64 description: Código do acidente acidenteVeiculoFacadeOutput: description: Fachada Acidente type: object required: – codigoAcidente – dataAcidente – horaAcidente – local – codigoVeiculo – codigoMotorista – avarias – descricaoAcidente – motoristaCulpado properties: codigoAcidente: type: integer format: int64 description: Código do acidente dataAcidente: type: string format: date-time description: Data do adidente horaAcidente: type: string description: Hora do acidente local: type: string maxLength: 255 description: Local do acidente codigoVeiculo: type: integer format: int64 description: Código do veículo codigoMotorista: type: integer format: int64 description: Código do motorista avarias: type: string maxLength: 255 description: Avarias descricaoAcidente: type: string maxLength: 255 description: Descrição do acidente motoristaCulpado: type: boolean description: Culpa do motorista veiculosDisponiveisFacadeInput: description: Fachada de veículos disponíveis type: object properties: codigoEmpresaVeiculo: type: integer format: int64 description: Código da empresa do veículo placa: type: string maxLength: 255 description: Placa do veículo codigoTipoVeiculo: type: integer format: int64 description: Código do tipo de veículo cnpjRegistroVeicular: type: string maxLength: 255 description: CNPJ do registro veicular situacaoRegistroVeicular: type: string allOf: – #/definitions/enumSituacaoRegistroVeicular description: Situação do veículo no registro veícular ativo: type: boolean description: Veículo ativo baixado: type: boolean description: Veículo baixado veiculosDisponiveisFacadeOutput: description: Fachada de veículos disponíveis type: object required: – placa – codigoVeiculo – numeroVeiculo – codigoTipoVeiculo – descricaoTipoVeiculo – apelidoTipoVeiculo – codigoEmpresaVeiculo – nomeEmpresaVeiculo – cnpjRegistroVeicular – nomeRegistroVeicular – situacaoRegistroVeicular properties: placa: type: string maxLength: 255 description: Placa do veículo codigoVeiculo: type: integer format: int64 description: Código do veículo numeroVeiculo: type: string maxLength: 255 description: Numero do veiculo codigoTipoVeiculo: type: integer format: int64 description: Código do tipo de veículo descricaoTipoVeiculo: type: string maxLength: 255 description: Descrição do tipo de veículo apelidoTipoVeiculo: type: string maxLength: 255 description: Apelido do tipo de veículo codigoEmpresaVeiculo: type: integer format: int64 description: Código da empresa do veículo nomeEmpresaVeiculo: type: string maxLength: 255 description: Nome da empresa do veículo cnpjRegistroVeicular: type: string maxLength: 255 description: CNPJ do registro veicular nomeRegistroVeicular: type: string maxLength: 255 description: Nome do registro veicular situacaoRegistroVeicular: type: string allOf: – #/definitions/enumSituacaoRegistroVeicular description: Situação registro veicular ativo: type: boolean description: Veículo ativo baixado: type: boolean description: Veículo baixado 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