umarley / seteAPI

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

Módulo ordemServico - GET - Obter dados de uma ordem de serviço específica #110

Closed nataliasou closed 1 year ago

nataliasou commented 2 years ago

image

Exemplo de requisição: GET https://sete.transportesufg.eng.br/ordens-servicos/5201405/1372 Resultado: • Retorno do HTTP é 200 - Ok • O resultado não está documentado na API • Está usando o seguinte formato { ..., result: "true" } • Possui links, não possui id da firebase, verificar se isso está correto

image

Exemplo de requisição: GET https://sete.transportesufg.eng.br/ordens-servicos/5201405/0 Resultado: • Retorno do HTTP é 404 – Not found • O resultado não está documentado na API • Está usando o seguinte formato { ..., result: "false" } • Possui links, não possui mensagem de erro, verificar se isso está correto

image

Exemplo de requisição: GET https://sete.transportesufg.eng.br/ordens-servicos/0/1372 Resultado: • Retorno do HTTP é 404 – Not found • O resultado não está documentado na API • Está usando o seguinte formato { ..., result: "false" } image

nataliasou commented 2 years ago

@umarley

get:
      tags:
      - ordemServico
      summary: Obter dados de uma ordem de serviço específica
      operationId: getOrdemServicoId
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        description: Código do municipio que a ordem de serviço pertence
        required: true
        type: integer
      - in: path
        name: id_ordem
        description: ID da ordem que se deseja consultar 
        required: true
        type: integer
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
              $ref: '#/definitions/OrdemServicoEspecifica'
        404:
          description: Recurso não encontrado.
      security:
      - api_key: []

Model:

OrdemServicoEspecifica:
    type: object
    properties:
      codigo_cidade:
        type: integer
      id_fornecedor:
        type: integer
      id_veiculo:
        type: integer
      termino:
        type: string
      data:
        type: string
        description: Data da Ordem de serviço no formato dd/mm/yyyy
      tipo_servico:
        type: integer
        description: Tipo do serviço 1. Combustível 2. Lubrificante 3. Pag. Seguro 4. Man. Preventiva 5. Manutenção 
        enum:
          - 1
          - 2
          - 3
          - 4
          - 5
      comentario:
        type: string
      id_ordem:
        type: integer
      id_firebase:
        type: integer
      result:
        type: boolean
umarley commented 1 year ago

API revisada e documentação atualizada