Pular para o conteúdo principal

Acreditações

Esta página descreve os endpoints da aba Acreditações, da tela Cursos. Uma acreditação registra que o curso é acreditado ou reconhecido por uma entidade, com o código de registro, a portaria e a validade. Um curso pode ter várias acreditações.

Endpoints​

MétodoCaminhoDescrição
GET/comercial/courses/{course_uuid}/accreditationsLista as acreditações do curso
POST/comercial/courses/{course_uuid}/accreditationsCadastra uma acreditação
PUT/comercial/courses/{course_uuid}/accreditations/{id}Altera uma acreditação
DELETE/comercial/courses/{course_uuid}/accreditations/{id}Apaga uma acreditação (exclusão lógica)
GET/comercial/courses/accreditations/companiesLista as empresas do cadastro do cliente, para o campo Empresa

Consultar​

GET /comercial/courses/{course_uuid}/accreditations​

Lista as acreditações do curso.

Parâmetros de URL: column e order para ordenação.

Resposta: lista. Campos principais: id, course_id, company_id, company_name, company_company_name, belong_to, registred_code, accreditation_date, ordinance, ordinance_english, due_date, observations, updated_at, user_create_name e user_update_name.

Cadastrar e alterar​

POST /comercial/courses/{course_uuid}/accreditations​

Corpo

CampoObrigatórioTipoDescrição
belong_toSimTextoEntidade que acredita o curso
registred_codeSimTextoNúmero de registro da acreditação
company_idNãoNúmero (id)Empresa do cadastro do cliente, quando a acreditação é de uma empresa cadastrada. Veja a lista de empresas deste endpoint
accreditation_dateNãoDataData da portaria
ordinanceNãoTextoPortaria, número ou descrição
ordinance_englishNãoTextoPortaria em inglês
due_dateNãoDataData até a qual a acreditação vale
observationsNãoTextoInformações complementares

Resposta: 200 com a acreditação criada.

PUT /comercial/courses/{course_uuid}/accreditations/{id}​

Altera uma acreditação. Envie apenas os campos que mudam, com os mesmos nomes da criação. Só company_id é validado nesta alteração.

Resposta: 200 com a acreditação alterada.

Apagar​

DELETE /comercial/courses/{course_uuid}/accreditations/{id}​

Apaga a acreditação. A exclusão é lógica.

Resposta: 200, sem corpo.

Listas de apoio​

GET /comercial/courses/accreditations/companies​

Lista as empresas do cadastro do cliente, para preencher o campo company_id. Use o id retornado.