152 lines
4.4 KiB
YAML
152 lines
4.4 KiB
YAML
tags:
|
|
- Company
|
|
summary: Lista todas as Companys com paginação.
|
|
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 Company
|
|
- 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 Companys com informações de paginação
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
description: Número total de empresas
|
|
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:
|
|
name:
|
|
type: string
|
|
description: Nome da Company
|
|
fantasyName:
|
|
type: string
|
|
description: Nome fantasia da empresa
|
|
cnpj:
|
|
type: number
|
|
description: cnpj da empresa
|
|
type:
|
|
type: string
|
|
description: area de atuação da empresa
|
|
contato:
|
|
type: number
|
|
description: contato
|
|
email:
|
|
type: string
|
|
description: email
|
|
email_sec:
|
|
type: string
|
|
description: email secundario
|
|
cep:
|
|
type: number
|
|
description: cep
|
|
phone_sec:
|
|
type: number
|
|
description: second phone
|
|
phone:
|
|
type: number
|
|
description: phone
|
|
|
|
rua:
|
|
type: string
|
|
description: endereco da empresa
|
|
numero:
|
|
type: string
|
|
description: complemento endereço
|
|
bairro:
|
|
type: string
|
|
description: bairro da empresa
|
|
complemento:
|
|
type: string
|
|
description: completo do endereço da empresa
|
|
estado:
|
|
type: string
|
|
description: estado onde a empresa se localiza
|
|
|
|
cidade:
|
|
type: string
|
|
description: cidade onde a empresa se localiza
|
|
|
|
service_instance_id:
|
|
type: integer
|
|
description: ID da empresa associada
|
|
|
|
examples:
|
|
application/json:
|
|
total: 2
|
|
pages: 1
|
|
current_page: 1
|
|
per_page: 10
|
|
roles:
|
|
- id: 1
|
|
name: "Company 1"
|
|
description: "Company hall de entrada."
|
|
status: "Ativa"
|
|
url: "http://exemplo.com"
|
|
service_id: 1
|
|
ambiente_id: 1
|
|
service_role_id: 1
|
|
service_instance_id: 1
|
|
|
|
- id: 2
|
|
name: "Company 1"
|
|
description: "Company estoque."
|
|
status: "Inativa"
|
|
url: "http://exemplo.com"
|
|
service_id: 1
|
|
ambiente_id: 1
|
|
service_role_id: 1
|
|
service_instance_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 Company encontrada
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
error:
|
|
type: string
|
|
examples:
|
|
application/json:
|
|
error: "Nenhuma Company encontrada"
|