Locais de treinamento

Locais de treinamento são as salas, unidades e endereços onde as turmas acontecem. Os endpoints desta página correspondem à tela Locais de treinamento do módulo Operacional. Os locais são usados como sala da turma na Agenda (veja Agenda).

Cada local tem dois identificadores: o uuid, usado no caminho das chamadas de consulta, alteração e exclusão, e o id numérico, usado como location_id na Agenda. As duas informações vêm na resposta da listagem.

Endpoints

Método	Caminho	Descrição
GET	/operational/training-locations	Lista os locais de treinamento
POST	/operational/training-locations	Cadastra um local de treinamento
GET	/operational/training-locations/vendors	Lista os fornecedores, para vincular ao local
PUT	/operational/training-locations/{uuid}	Altera um local de treinamento
DELETE	/operational/training-locations/{uuid}	Apaga um local de treinamento

GET /operational/training-locations

Lista os locais de treinamento do cliente.

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
search	Não	Texto buscado no nome do local
customer_vendor_id	Não	id numérico do fornecedor vinculado ao local
column	Não	Coluna para ordenar a lista
order	Não	Direção da ordenação: asc ou desc. A ordenação só é aplicada se column também for enviado
per_page	Não	Quantidade de registros por página. Veja Convenções
page	Não	Número da página, quando per_page for informado

Resposta

Status 200. Sem per_page, a resposta é uma lista de locais. Com per_page, a resposta é paginada. Cada local traz id, uuid, name, customer_vendor_id, customer_vendor_name, os campos de endereço (zip_code, street, number, complement, neighborhood, city, state), user_create_name e user_update_name.

curl "https://api.pedagogo.app/operational/training-locations?search=Sala&per_page=15&page=1" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

POST /operational/training-locations

Cadastra um local de treinamento. O cliente é o do usuário que faz a chamada.

Corpo

Campo	Obrigatório	Tipo	Descrição
name	Sim	Texto	Nome do local
customer_vendor_id	Não	Inteiro	id do fornecedor vinculado ao local, da listagem de /operational/training-locations/vendors
zip_code	Não	Texto	CEP
street	Não	Texto	Rua ou logradouro
number	Não	Texto	Número do endereço
complement	Não	Texto	Complemento do endereço
neighborhood	Não	Texto	Bairro
city	Não	Texto	Cidade
state	Não	Texto	Estado

Resposta

Status 200, com o local cadastrado. A resposta traz o id e o uuid do novo local.

curl -X POST https://api.pedagogo.app/operational/training-locations \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -d '{"name": "Sala Exemplo 1", "street": "Rua Exemplo", "number": "100", "city": "Cidade Exemplo", "state": "SP"}'

GET /operational/training-locations/vendors

Lista os fornecedores cadastrados no cliente, para usar em customer_vendor_id. Use o campo id de cada fornecedor.

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
per_page	Não	Quantidade de registros por página
page	Não	Número da página, quando per_page for informado

Resposta

Status 200. Lista de fornecedores, com os campos do cadastro (entre eles id, uuid, name e company_name). Sem per_page, a resposta é uma lista simples.

PUT /operational/training-locations/{uuid}

Altera um local de treinamento. Envie apenas os campos que serão alterados. Os campos não enviados mantêm o valor atual.

Parâmetros de URL

Parâmetro	Descrição
uuid	uuid do local

Corpo

Campo	Obrigatório	Tipo	Descrição
name	Não	Texto	Nome do local
customer_vendor_id	Não	Inteiro	id do fornecedor vinculado. Envie null para remover o vínculo
zip_code	Não	Texto	CEP
street	Não	Texto	Rua ou logradouro
number	Não	Texto	Número do endereço
complement	Não	Texto	Complemento do endereço
neighborhood	Não	Texto	Bairro
city	Não	Texto	Cidade
state	Não	Texto	Estado

Resposta

Status 200, com o local alterado.

curl -X PUT https://api.pedagogo.app/operational/training-locations/3f1c0b6e-8a2d-4c57-9b1e-2d7a5f0e6a11 \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -d '{"city": "Cidade Exemplo 2"}'

DELETE /operational/training-locations/{uuid}

Apaga um local de treinamento. A exclusão é lógica: o local deixa de aparecer nas listas, e os dados são mantidos.

Parâmetros de URL

Parâmetro	Descrição
uuid	uuid do local

Resposta

Status 200, sem corpo.