umarley / seteAPI

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

Módulo Alunos - GET - Obter dados da escola associada ao aluno #118

Closed glcalil-ufg closed 1 year ago

glcalil-ufg commented 2 years ago

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/alunos/5201405/1/escola

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

  • Campo telefone incompleto verificar se é o correto


Exemplo de requisição:

GET https://sete.transportesufg.eng.br/alunos/5201405/1/escola

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" }

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/alunos/5201405999/9/escola

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:
      - alunos
      summary: Obter os dados da escola associada ao aluno
      description: Retonar dados da escola associado ao aluno
      operationId: getEscolaAluno
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        type: integer
        description: Código da cidade do aluno a ser atualizado
        required: true
      - name: id_aluno
        in: path
        description: ID of pet to return
        required: true
        type: integer
        format: int64
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
            $ref: '#/definitions/EscolaAluno'
        400:
          description: Parametros incorretos
        404:
          description: Escola não encontrada
      security:
      - api_key: []

Modelo

EscolaAluno:
    type: object
    properties:
      id_escola:
        type: integer
      id_aluno:
        type: integer
      codigo_cidade:
        type: integer
      nome:
        type: string
      mec_co_entidade:
        type: integer
      mec_co_uf:
        type: integer
      mec_co_municipio:
        type: integer
      mec_no_entidade:
        type: string  
      mec_tp_dependencia:
        type: integer
        description: Tipo de dependência da escola 1. Federal 2. Estadual 3. Municipal 4. Privada
        enum:
        - 1
        - 2
        - 4
      mec_tp_localizacao:
        type: integer
        description: Localização da escola 1. Urbana 2. Rural
        enum:
        - 1
        - 2
        - 4
      mec_tp_localizacao_diferenciada:
        type: integer
        description: Localização da escola 1. Área de Assentamento 2. Terra Indígena 3. Área remanescente de Quilombo 7. Não se aplica
        enum:
        - 1
        - 2
        - 3
        - 7
      mec_in_regular:
        type: string
        description: Escola oferta ensino regular? S = Sim N = Não
        enum:
        - S
        - N
      mec_in_eja:
        type: string
        description: Escola oferta ensino para jovens e adultos? S = Sim N = Não
        enum:
        - S
        - N
      mec_in_profissionalizante:
        type: string
        description: Escola oferta ensino profissionalizante? S = Sim N = Não
        enum:
        - S
        - N
      mec_in_especial_exclusiva:
        type: string
        description: Escola oferta ensino especial? S = Sim N = Não
        enum:
        - S
        - N
      loc_latitude:
        type: string
      loc_longitude:
        type: string
      loc_endereco:
        type: string
      loc_cep:
        type: string
      contato_responsavel:
        type: string
      contato_telefone:
        type: string
      contato_email:
        type: string
      horario_matutino:
        type: string
        description: Escola funciona no horário matutino? S = Sim N = Não
        enum:
        - S
        - N
      horario_vespertino:
        type: string
        description: Escola funciona no horário vespertino? S = Sim N = Não
        enum:
        - S
        - N
      horario_noturno:
        type: string
        description: Escola funciona no horário noturno? S = Sim N = Não
        enum:
        - S
        - N
      ensino_superior:
        type: string
        description: Escola oferece ensino superior? S = Sim N = Não
        enum:
        - S
        - N
      ensino_medio:
        type: string
        description: Escola oferece ensino médio? S = Sim N = Não
        enum:
        - S
        - N
      ensino_fundamental:
        type: string
        description: Escola oferece ensino fundamental? S = Sim N = Não
        enum:
        - S
        - N
      ensino_pre_escola:
        type: string
        description: Escola oferece ensino pré-escola? S = Sim N = Não
        enum:
        - S
        - N
      dt_criacao:
        type: string
      criado_por:
        type: string
      dt_alteracao:
        type: string
      alterado_por:
        type: string
      result:
        type: boolean
    xml:
      name: Escola
umarley commented 1 year ago

API revisada e documentação atualizada.