front_ponto_eletronico/docs/company/create.yml
2025-04-16 19:48:09 -03:00

178 lines
4.8 KiB
YAML

tags:
- Company
summary: Cria uma nova Company
security:
- bearerAuth: []
parameters:
- in: body
name: body
description: Dados para a criação de uma nova Company
required: true
schema:
type: object
properties:
name:
type: string
description: Nome da Company
example: "Company entrada"
fantasyName:
type: string
description: Nome fantasia da empresa
example: "Company entrada"
cnpj:
type: number
description: cnpj da empresa
example: "---"
type:
type: string
description: area de atuação da empresa
example: "Alimenticio"
contato:
type: number
description: contato
example: "219876-6543"
email:
type: string
description: email
example: "example@gmail.com"
email_sec:
type: string
description: email secundario
example: "example@gmail.com"
cep:
type: number
description: cep
example: "12345678"
phone_sec:
type: number
description: second phone
example: "2198768654"
phone:
type: number
description: phone
example: "2198763654"
rua:
type: string
description: endereco da empresa
example: "rua exemplo"
numero:
type: string
description: complemento endereço
example: "rua exemplo"
bairro:
type: string
description: bairro da empresa
example: "centro"
complemento:
type: string
description: completo do endereço da empresa
example: "rua A"
estado:
type: string
description: estado onde a empresa se localiza
example: "Rio de Janeiro"
cidade:
type: string
description: cidade onde a empresa se localiza
example: "Rio de Janeiro"
service_instance_id:
type: integer
description: ID da empresa associada
example: 1
responses:
201:
description: Company cadastrada com sucesso
content:
application/json:
schema:
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:
id: 1
name: "Company entrada"
description: "Company sony entrada."
status: "Ativo"
url: "http://exemplo.com"
service_id: 3
ambiente_id: 1
service_role_id: 5
service_instance_id: 1
400:
description: Requisição inválida (dados incorretos ou ausentes)
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Os campos 'name' e 'service_id' são obrigatórios."
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"