umarley / seteAPI

BSD 3-Clause "New" or "Revised" License
2 stars 0 forks source link

Módulo Motoristas - GET - Obter dados de um motorista especifico #121

Closed glcalil-ufg closed 1 year ago

glcalil-ufg commented 2 years ago

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/motoristas/5201405/16709683320

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á vários campos NULL, verificar se é o correto com o Prof.  Marcos e o Umarley


Exemplo de requisição:

GET https://sete.transportesufg.eng.br/motoristas/520140599/16709683320

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 : “...” }

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/motoristas/5201405/1670968332099

Resultado do experimento:

  • Retorno do HTTP está 404 (NOT FOUND)

  • O resultado está diferente do esperado na API

  • Está usando o seguinte formato 

Erro não capturado, { result: "false" }



glcalil-ufg commented 2 years ago

@umarley

get:
      tags:
      - motoristas
      summary: Obter dados de um motorista específico
      operationId: getMotoristaId
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        description: Código do municipio que o motorista pertence
        required: true
        type: integer
      - in: path
        name: cpf_motorista
        description: CPF do motorista que se deseja consultar 
        required: true
        type: integer
      responses:
        200:
          description: Operação Realizada com Sucesso
          schema:
            $ref: '#/definitions/MotoristaCompleto'
        400:
          description: Parametros incorretos
        404:
          description: Motorista não encontrado
      security:
      - api_key: []

Modelo

MotoristaCompleto:
    type: object
    required:
     - cpf
     - nome
     - data_nascimento
     - cnh
     - sexo
    properties:
      codigo_cidade:
        type: integer
      nome:
        type: string
      data_nascimento:
        description: Data de nascimento no formato dd/mm/yyyy
        type: string
      sexo:
        type: integer
        description: Sexo do Motorista 1. Masculino 2. Feminino 3. Não Informado
        enum:
        - 1
        - 2
        - 3
      cpf:
        type: string
      telefone:
        type: string
      cnh:
        type: string
      ant_criminais:
        type: string
        description: Número do documento de antecedentes criminais
      arquivo_docpessoais_anexo:
        type: string
      tem_cnh_a:
        type: string
        description: Tem CNH categoria A? S = Sim N = Não
        enum:
        - S
        - N
      tem_cnh_b:
        type: string
        description: Tem CNH categoria B? S = Sim N = Não
        enum:
        - S
        - N
      tem_cnh_c:
        type: string
        description: Tem CNH categoria C? S = Sim N = Não
        enum:
        - S
        - N
      tem_cnh_d:
        type: string
        description: Tem CNH categoria D? S = Sim N = Não
        enum:
        - S
        - N
      tem_cnh_e:
        type: string
        description: Tem CNH categoria E? S = Sim N = Não
        enum:
        - S
        - N
      turno_manha:
        type: string
        description: Trabalha no turno da manhã? S = Sim N = Não
        enum:
        - S
        - N
      turno_tarde:
        type: string
        description: Trabalha no turno da tarde? S = Sim N = Não
        enum:
        - S
        - N
      turno_noite:
        type: string
        description: Trabalha no turno da noite? S = Sim N = Não
        enum:
        - S
        - N
      id_firebase:
        type: integer
      data_validade_cnh:
        type: string
        description: Data da validade da CNH no formato dd/mm/yyyy
      vinculo:
        type: integer
        description: Vínculo do motorista com a administração pública 1. Servidor efetivo 2. Servidor comissionado 3. Servidor terceirizado 4. Outro
        enum:
        - 1
        - 2
        - 3
        - 4
      salario:
        type: number
        description: Salário pago ao motorista
      result:
        type: boolean
umarley commented 1 year ago

API revisada e documentação atualizada