Open glcalil-ufg opened 2 years ago
@umarley
post:
tags:
- veiculos
summary: Cadastrar um novo veículo no sistema SETE
operationId: newVeiculo
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: body
name: body
description: Objeto dados do veículo a ser cadastrado
required: true
schema:
$ref: '#/definitions/Veiculo'
responses:
201:
description: Operacão realizada com sucesso
schema:
$ref: '#/definitions/CreateResponse'
400:
description: Parâmetros invalidos
404:
description: Não encontrado
security:
- api_key: []
Modelo Body
Veiculo:
type: object
required:
- placa
- marca
- modelo
- modo
- origem
- tipo
properties:
placa:
type: string
marca:
type: integer
modelo:
type: integer
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
km_atual:
type: number
capacidade:
type: integer
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
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
xml:
name: Veículo
Exemplo de requisição:
POST https://sete.transportesufg.eng.br/veiculos/5201405
Path:
codigo_cidade: 5201405
Body:
Resultado do experimento:
Retorno do HTTP está 200 (OK)
O resultado está diferente do esperado na API
Está usando o seguinte formato
{ result: "false", messages : “...” }
Não foi possível cadastrar um veículo, formato dos dados indicados na documentação API não estão coerentes com o esperado pela API real
Exemplo de requisição:
POST https://sete.transportesufg.eng.br/motoristas/5201405
1 - Campos obrigatórios faltantes;
2 - Codigo cidade errado;
Resultado do experimento:
Retorno do HTTP está 400 (BAD REQUEST)
O resultado está diferente do esperado na API
Está usando o seguinte formato
{ result: "false", messages : “...” }