Pular para o conteúdo principal

Cursos da proposta

Corresponde à seção Cursos da página da proposta, na tela Propostas. Lista os cursos oferecidos, com a modalidade e os valores bruto e líquido.

Endpoints​

MétodoCaminhoDescrição
GET/crm/proposals/{proposal_uuid}/coursesLista os cursos da proposta
POST/crm/proposals/{proposal_uuid}/coursesInclui um curso na proposta
GET/crm/proposals/{proposal_uuid}/courses/{id}Consulta um curso da proposta
PUT/crm/proposals/{proposal_uuid}/courses/{id}Altera um curso da proposta
DELETE/crm/proposals/{proposal_uuid}/courses/{id}Remove um curso da proposta
GET/crm/proposals/coursesLista os cursos do catálogo (apoio)
GET/crm/proposals/modalitiesLista as modalidades (apoio)

GET /crm/proposals/{proposal_uuid}/courses​

Lista os cursos da proposta.

Parâmetros de URL

ParâmetroDescrição
searchTexto no nome do curso ou da modalidade
per_page, pagePaginação, conforme Convenções

Resposta (200): a lista de cursos, com o nome do curso, a modalidade e os valores, e os nomes de quem criou e de quem alterou.

POST /crm/proposals/{proposal_uuid}/courses​

Inclui um curso na proposta.

Corpo

CampoObrigatórioTipoDescrição
course_idSiminteiroCurso oferecido (id do catálogo de cursos)
modality_idNãointeiroModalidade do curso
gross_valueSimnúmeroValor bruto do curso
net_valueSimnúmeroValor líquido do curso

Exemplo

curl -X POST https://api.pedagogo.app/crm/proposals/<uuid-da-proposta>/courses \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Content-Type: application/json" \
-d '{
"course_id": 1,
"modality_id": 1,
"gross_value": 1000.00,
"net_value": 900.00
}'

Resposta (201): o curso incluído na proposta.

PUT /crm/proposals/{proposal_uuid}/courses/{id}​

Altera o curso da proposta. Envie apenas os campos que mudam.

Corpo

CampoObrigatórioTipoDescrição
course_idNãointeiroCurso oferecido
modality_idNãointeiroModalidade do curso

Resposta (200): o curso alterado.

Consultar e apagar​

GET /crm/proposals/{proposal_uuid}/courses/{id} traz o curso da proposta. DELETE /crm/proposals/{proposal_uuid}/courses/{id} remove o curso da proposta. Resposta (200).

GET /crm/proposals/courses​

Lista os cursos do catálogo, para o campo course_id. Resposta (200): a lista de cursos.

GET /crm/proposals/modalities​

Lista as modalidades, para o campo modality_id. Resposta (200): a lista de modalidades.