Módulo Veículos - GET - Obter dados de um veículo específico

glcalil-ufg commented 2 years ago

Exemplo de requisição:
GET https://sete.transportesufg.eng.br/veiculos/5201405/1
Resultado do experimento:
Retorno do HTTP está 200 (OK)
O resultado está diferente do esperado na API
Está usando o seguinte formato
{ ..., result: "true" }
Há campos do tipo _links, deve ser feito assim mesmo?
Há vários campos NULL, verificar se isto é correto.

Exemplo de requisição:
GET https://sete.transportesufg.eng.br/veiculos/520140599/1
Resultado do experimento:
Retorno do HTTP está 404 (NOT FOUND)
O resultado está diferente do esperado na API
Está usando o seguinte formato
{ result: "false", messages : “...” }

glcalil-ufg commented 2 years ago

@umarley

get:
      tags:
      - veiculos
      summary: Obter dados de um veículo específico
      operationId: getVeiculoId
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        description: Código do municipio que o veículo pertence
        required: true
        type: integer
      - in: path
        name: id_veiculo
        description: ID do veículo que se deseja consultar 
        required: true
        type: integer
      responses:
        200:
          description: Operação Realizada com Sucesso
          schema: 
            $ref: '#/definitions/veiculoCompleto'
        400:
          description: Parâmetros incorretos
        404:
          description: Veículo não encontrado
      security:
      - api_key: []

Modelo

veiculoCompleto:
    type: object
    properties:
      codigo_cidade:
        type: integer
      id_veiculo:
        type: integer
      placa:
        type: string
      ano:
        type: integer
      modo:
        type: integer
        description: Modalidade do veículo 0. Rodoviário 1. Aquaviario
        enum:
        - 0
        - 1
      origem:
        type: integer
        description: Origem do veículo 1. Próprio 2. Terceirizado
        enum:
        - 1
        - 2
      km_inicial:
        type: number
      capacidade:
        type: integer
      km_atual:
        type: number
      tipo:
        type: integer
        description: Tipo do veículo 1. Ônibus 2. Micro-ônibus 3. Van 4. Kombi 5. Caminhão 6. Caminhonete 7. Motocicleta 8. Animal de tração 9. Lancha/Voadeira 10. Barco de madeira 11. Barco de alumínio 12. Canoa motorizada 13. Canoa a remo
        enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
        - 13
      renavam:
        type: string
      manutencao:
        type: string
      marca:
        type: integer
      id_firebase:
        type: string
      ipva:
        type: number
        description: Valor do IPVA
      dpvat:
        type: number
        description: Valor do DPVAT
      seguro_anual:
        type: number
        description: Valor do Seguro anual
      consumo:
        type: number
        description: Consumo do veículo KM/L ou L/hora
      tipo_combustivel:
        type: string
        description: Tipo do combustível utilizado pelo veículo G - Gasolina D - Diesel E - Etanol N - Gás Natural O - Outro
        enum:
        - G
        - D
        - E
        - N
        - O
      numero_de_pneus:
        type: integer
      vida_util_do_pneu:
        type: number
      preco:
        type: number
      potencia_do_motor:
        type: string
      modelo:
        type: integer
      marca_str:
        type: string
      modo_str:
        type: string
      origem_str:
        type: string
      result:
        type: boolean  
    xml:
      name: Veículo

umarley commented 1 year ago

API revisada e documentação atualizada

umarley / seteAPI

Módulo Veículos - GET - Obter dados de um veículo específico #127