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

125 lines
2.8 KiB
YAML

tags:
- Company
summary: "Atualiza os dados de uma Company"
description: "Permite atualizar o nome e a descrição de uma Company."
parameters:
- name: "Company_id"
in: "path"
required: true
type: "integer"
description: "ID de uma Company."
- name: "name"
in: "body"
required: false
schema:
type: "string"
description: "Nome da Company."
- name: "fantasyName"
in: "body"
required: false
schema:
type: "string"
description: "Nome famtasia da Company."
- name: "cnpj"
in: "body"
required: false
schema:
type: "number"
description: "numero do cnpj Company."
- name: "type"
in: "body"
required: false
schema:
type: "string"
description: " tipo da Company(area de atuação)."
- name: "service_instance_id"
in: "body"
required: false
schema:
type: "integer"
description: "empresa associada a Company."
- name: "phone"
in: "body"
required: false
schema:
type: "number"
description: " contato da Company."
- name: "phone_sec"
in: "body"
required: false
schema:
type: "number"
description: " contato secundario da Company."
- name: "email"
in: "body"
required: false
schema:
type: "string"
description: " email da Company."
- name: "email_sec"
in: "body"
required: false
schema:
type: "string"
description: " email secundario da Company."
- name: "cep"
in: "body"
required: false
schema:
type: "number"
description: " cep da Company."
- name: "rua"
in: "body"
required: false
schema:
type: "string"
description: " rua da Company."
- name: "numero"
in: "body"
required: false
schema:
type: "number"
description: " complemento do endereço da Company."
- name: "bairro"
in: "body"
required: false
schema:
type: "string"
description: " bairro da Company."
- name: "complemento"
in: "body"
required: false
schema:
type: "string"
description: " informações adicionais do endereço da Company."
- name: "estado"
in: "body"
required: false
schema:
type: "string"
description: " estado da Company."
- name: "municipio"
in: "body"
required: false
schema:
type: "string"
description: " municipio da Company."
responses:
200:
description: "Company atualizada com sucesso"
schema:
type: "object"
properties:
message:
type: "string"
example: "Company atualizada com sucesso"
404:
description: "Company não encontrada"
schema:
type: "object"
properties:
error:
type: "string"
example: "Company não encontrada"