front_ponto_eletronico/docs/service_instance/get.yml
2025-04-16 19:48:09 -03:00

100 lines
2.6 KiB
YAML

tags:
- Service Instance
summary: "Retorna todas as Empresas."
security:
- bearerAuth: []
parameters:
- in: query
name: page
required: false
schema:
type: integer
default: 1
description: Número da página a ser retornada
status: Status da empresa
- in: query
name: per_page
required: false
schema:
type: integer
default: 10
description: Número de funções de serviço por página
responses:
200:
description: Lista de cameras com informações de paginação
content:
application/json:
schema:
type: object
properties:
total:
type: integer
description: "Número total de funções de serviço"
pages:
type: integer
description: "Número total de páginas"
current_page:
type: integer
description: Página atual
per_page:
type: integer
description: Número de itens por página
roles:
type: array
items:
type: object
properties:
id:
type: integer
description: "ID da empresa"
name:
type: string
description: "Nome da empresa"
description:
type: string
description: "Descrição da empresa"
service_id:
type: integer
description: ID do serviço associado
examples:
application/json:
total: 2
pages: 1
current_page: 1
per_page: 10
roles:
- id: 1
name: "Farmacia"
description: "farmacia 1"
service_id: 1
- id: 2
name: "Farmacia 2"
description: "Farmacia 2"
service_id: 1
401:
description: Token inválido ou ausente
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Token inválido ou ausente"
404:
description: Nenhuma camera encontrada
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Nenhuma camera encontrada"