Assinaturas
Esta página descreve os endpoints da aba Assinaturas, da tela Cursos. Ela cadastra as pessoas da empresa que assinam os certificados do curso, com o cargo e o documento de cada uma. As assinaturas aparecem em certificados de vários modelos.
Cada empresa tem uma única assinatura por curso.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /comercial/courses/{course_uuid}/signatures | Lista as assinaturas do curso |
| POST | /comercial/courses/{course_uuid}/signatures | Cadastra uma assinatura |
| PUT | /comercial/courses/{course_uuid}/signatures/{id} | Altera uma assinatura |
| DELETE | /comercial/courses/{course_uuid}/signatures/{id} | Apaga uma assinatura (exclusão lógica) |
| GET | /comercial/courses/{course_uuid}/signatures/{id}/show-signature | Baixa a imagem da assinatura |
| DELETE | /comercial/courses/{course_uuid}/signatures/{id}/delete-signature | Apaga a imagem da assinatura |
| GET | /comercial/courses/companies/{customer_vendor_uuid}/cost-centers | Lista os centros de custo de uma empresa, para o campo Centro de custo |
Consultar
GET /comercial/courses/{course_uuid}/signatures
Lista as assinaturas do curso. Sem ordenação, a lista sai por nome.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
customer_vendor_id | Lista apenas as assinaturas da empresa informada (id da empresa) |
search | Texto livre: nome, cargo ou documento de quem assina |
column e order | Ordenação: nome da coluna e asc ou desc |
Resposta: lista. Campos principais: id, course_id, customer_vendor_id, customer_name, customer_company_name, customer_vendor_document, cost_center_id, name, role, document, upload_id, user_create_name e user_update_name.
Cadastrar e alterar
POST /comercial/courses/{course_uuid}/signatures
Cadastra uma assinatura. Se a empresa já tem assinatura neste curso, o sistema atualiza o cadastro existente, em vez de criar outro.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
customer_vendor_id | Sim | Número (id) | Empresa à qual a assinatura pertence |
name | Sim | Texto | Nome de quem assina |
cost_center_id | Não | Número (id) | Centro de custo da empresa escolhida. Veja a lista de centros de custo desta página |
role | Não | Texto | Cargo ou função de quem assina |
document | Não | Texto | Documento de identificação de quem assina |
Esta referência não cobre o envio da imagem da assinatura.
Resposta: 200 com a assinatura cadastrada ou atualizada.
PUT /comercial/courses/{course_uuid}/signatures/{id}
Altera os dados de quem assina. Os campos são os mesmos do cadastro. customer_vendor_id e name são obrigatórios também nesta alteração.
Resposta: 200 com a assinatura alterada.
Imagem da assinatura
GET /comercial/courses/{course_uuid}/signatures/{id}/show-signature
Baixa a imagem cadastrada para a assinatura.
Resposta: arquivo para download. Se a assinatura não tem imagem, a resposta é 404.
DELETE /comercial/courses/{course_uuid}/signatures/{id}/delete-signature
Apaga a imagem da assinatura e o arquivo enviado. Os dados de quem assina são mantidos.
Resposta: 200 com a assinatura, sem a imagem. Se a assinatura não tem imagem, nada é alterado.
Apagar
DELETE /comercial/courses/{course_uuid}/signatures/{id}
Apaga a assinatura. A exclusão é lógica.
Resposta: 200, sem corpo.
Listas de apoio
GET /comercial/courses/companies/{customer_vendor_uuid}/cost-centers
Lista os centros de custo da empresa indicada pelo uuid. Use o id retornado no campo cost_center_id.