⚙️Curseduca Contents

API Curseduca para manipulação dos conteúdos da plataforma

Matrículas

chevron-rightPOST /enrollmentshashtag

Parameters

  • No parameters

Request body - application/json

  • Example Value

{
  "member": {
    "id": 0,
    "email": "string"
  },
  "contentId": 0
}

Responses

Code
Description
Links

201

Matrícula criada com sucesso!

No links

404

Conteúdo/Membro não encontrado.

No links

409

Membro já matriculado no conteúdo.

No links

chevron-rightDELETE /enrollments/{id}hashtag

Parameters

Name
Description

id *

string(path)

id

Responses

Code
Description
Links

200

Matrícula cancelada com sucesso!

No links

404

Conteúdo/Membro não encontrado.

No links

chevron-rightPUT / enrollments/{id}hashtag

Parameters

Name
Description

id *

string(path)

id

Responses

Code
Description
Links

200

Matrícula atualizada com sucesso!

No links

404

Conteúdo/Membro não encontrado.

No links

chevron-rightPATCH /enrollments / {id} / restorehashtag

Parameters

Name
Description

id *

string(path)

id

Responses

Code
Description
Links

200

Matrícula restaurada com sucesso!

No links

404

Conteúdo/Membro não encontrado.

No links

Fóruns

chevron-rightGET / forumshashtag

Parameters

No parameters

Responses

Code
Description
Links

200

Fóruns listados com sucesso!

No links

chevron-rightGET / forums / {uuid}hashtag

Parameters

Name
Description

uuid *

string(path)

uuid

Responses

Code
Description
Links

200

No links

chevron-rightPUT / forums / {uuid}hashtag

Parameters

Name
Description

uuid *

string(path)

uuid

Responses

Code
Description
Links

200

No links

chevron-rightDELETE / forums / {uuid}hashtag

Parameters

Name
Description

uuid *

string(path)

uuid

Responses

Code
Description
Links

200

No links

chevron-rightPOST / forums / {uuid} / answerhashtag

Parameters

Name
Description

uuid *

string(path)

uuid

Responses

Code
Description
Links

201

No links

chevron-rightPATCH / forums / {uuid} / pinhashtag

Parameters

Name
Description

uuid *

string(path)

uuid

Responses

Code
Description
Links

200

No links

chevron-rightPATCH / forums / {uuid} / unpinhashtag

Parameters

Name
Description

uuid *

string(path)

uuid

Responses

Code
Description
Links

200

No links

chevron-rightPATCH / forums / {uuid} / readhashtag

Parameters

Name
Description

uuid *

string(path)

uuid

Responses

Code
Description
Links

200

No links

chevron-rightPATCH / forums / {uuid} / unreadhashtag

Parameters

Name
Description

uuid *

string(path)

uuid

Responses

Code
Description
Links

200

No links

chevron-rightPATCH / forums / {uuid} / disable-commentshashtag

Parameters

Name
Description

uuid *

string(path)

uuid

Responses

Code
Description
Links

200

No links

chevron-rightPATCH / forums / {uuid} /enable-commentshashtag

Parameters

Name
Description

uuid *

string(path)

uuid

Responses

Code
Description
Links

200

No links

chevron-rightPOST / forums / {uuid} / sharehashtag

Parameters

Name
Description

uuid *

string(path)

uuid

Responses

Code
Description
Links

201

No links

Materiais

chevron-rightDELETE / lessons / {id}hashtag

Parameters

Name
Description

id *

number(path)

id

Responses

Code
Description
Links

204

Aula removida com sucesso!

No links

Default

chevron-rightPOST / lessons / {id}hashtag

Parameters

Name
Description

id *

string(path)

id

Responses

Code
Description
Links

204

Aula salva com sucesso!

No links

chevron-rightGET / menus / current / {tenantUuid}hashtag

Parameters

Try it out

Name
Description

tenantUuid *

string(path)

tenantUuid

Responses

Code
Description
Links

200

No links

chevron-rightGET / showcases / member / contents / is-watchinghashtag

Parameters

No parameters

Responses

Code
Description
Links

200

No links

chevron-rightGET / showcases / member / contentshashtag

Parameters

Name
Description

Authorization *

string(header)

Authorization

Responses

Code
Description
Links

200

No links

chevron-rightDELETE / cache / communityhashtag

Parameters

No parameters

Responses

Code
Description
Links

200

No links

chevron-rightGET / tenants / using-communityhashtag

Parameters

No parameters

Responses

Code
Description
Links

200

No links

chevron-rightDELETE / forums /{forumId} / answers / {answerId} /deletehashtag

Parameters

Name
Description

answerId *

string(path)

answerId

Responses

Code
Description
Links

200

No links

chevron-rightPATCH / quizes / members / questions / {memberQuestionId} / approvehashtag

Parameters

Name
Description

memberQuestionId *

string(path)

memberQuestionId

Responses

Code
Description
Links

200

No links

chevron-rightPATCH / quizes / members / questions / {memberQuestionId} / reprovehashtag

Parameters

Name
Description

memberQuestionId

*string(path)

memberQuestionId

Responses

Code
Description
Links

200

No links

chevron-rightPOST /lessons / assessments / {memberAssessmentId} / correctionhashtag

Parameters

Name
Description

memberAssessmentId *

string(path)

memberAssessmentId

Responses

Code
Description
Links

201

No links

chevron-rightPOST /lessons / {lessonId} / flashcards / {flashcardId}hashtag

Parameters

Name
Description

lessonId *

string(path)

lessonId

flashcardId *

string(path)

flashcardId

Responses

Code
Description
Links

201

No links

chevron-rightPOST / move-folder-to-other-communityhashtag

Parameters

No parameters

Responses

Code
Description
Links

201

No links

chevron-rightPOST / emailshashtag

Parameters

No parameters

Responses

Code
Description
Links

201

No links

chevron-rightDELETE / emailshashtag

Parameters

No parameters

Responses

Code
Description
Links

200

No links

chevron-rightPOST / orderbumphashtag

Parameters

No parameters

Responses

Code
Description
Links

201

No links

chevron-rightDELETE /orderbump / {uuid}hashtag

Parameters

Name
Description

uuid *

string(path)

uuid

Responses

Code
Description
Links

200

No links

chevron-rightGET / lessons / assessments /{memberAssessmentId}/ attempthashtag

Parameters

Name
Description

memberAssessmentId *

string(path)

memberAssessmentId

Responses

Code
Description
Links

200

No links

chevron-rightGET / lessons / assessments / correction / {correctionId}hashtag

Parameters

Name
Description

correctionId *

string(path)

correctionId

admin *

string(query)

admin

Responses

Code
Description
Links

200

No links

chevron-rightGET / lessons / {lessonId} / flashcardshashtag

Parameters

Name
Description

lessonId *

string(path)

lessonId

Responses

Code
Description
Links

200

No links

chevron-rightGET / hchashtag

Parameters

No parameters

Responses

Code
Description
Links

200

No links

chevron-rightGET / orderbumpshashtag

Parameters

No parameters

Responses

Code
Description
Links

200

No links

chevron-rightGET /reports /group /tenantshashtag

Parameters

No parameters

Responses

Code
Description
Links

200

No links

chevron-rightGET /members /channels/has-accesshashtag

Parameters

No parameters

Responses

Code
Description
Links

200

No links

Relatórios

chevron-rightGET / api / reports / enrollmentshashtag

Parameters

Name
Description

limit

number

(query)

Número de registros por página (max 100)

offset

number

(query)

Número de registros a serem ignorados

memberId

string

(query)

ID do membro para filtrar matrículas

export

string

(query)

Exportar relatório (true/false)

Responses

Code
Description
Links

200

Relatório de matrículas gerado com sucesso!

Media type:

application/jsonControls

  • Example Value:

No links

chevron-rightGET / reports / progresshashtag

Parameters

Name
Description

limit

number

(query)

Número de registros por página (max 100)

offset

number

(query)

Número de registros a serem ignorados

content

string

(query)

Nome, slug ou ID do conteúdo

lesson

string

(query)

Nome ou ID da aula

section

string

(query)

Nome ou ID do módulos

finishedSince

string($date-time)

(query)

Data inicial de finalização da aula

finishedUntil

string($date-time)

(query)

Data final de finalização da aula

startUpdatedAt

string($date-time)

(query)

Data inicial de atualização

endUpdatedAt

string($date-time)

(query)

Data final de atualização

member

string

(query)

Nome, email, slug ou ID do membro

group

string

(query)

Nome ou ID do grupos

Responses

Code
Description
Links

200

Relatório de progresso gerado com sucesso!

Media type:

application/jsonControls

  • Example Value:

No links

Showcases

chevron-rightGET / showcaseshashtag

Parameters

No parameters

Responses

Code
Description
Links

200

Vitrines listadas com sucesso!

Media type:

application/jsonControls

  • Example Value:

No links

Comunidade

chevron-rightGET /tenants /{tenantUuid} / communityhashtag

Parameters

Name
Description

tenantUuid *

string(path)

tenantUuid

Responses

Code
Description
Links

200

Listagem das comunidades do tenant.

Media type:

application/jsonControls

  • Example Value

No links

chevron-rightGET / community / channels / {uuid} / postshashtag

Parameters

Name
Description

uuid *

string(path)

uuid

Responses

Code
Description
Links

200

Posts listados com sucesso!

Media type:

application/jsonControls

  • Example Value

No links

Conteúdos

chevron-rightDELETE / contents / {id}hashtag

Parameters

Name
Description

id *

number(path)

id

Authorization *

string (header)

Authorization

Responses

Code
Description
Links

204

Conteúdo removido com sucesso!

No links

Categorias

chevron-rightPOST / categories / {id}hashtag

Parameters

Name
Description

id *

string(path)

id

Responses

Code
Description
Links

200

Categoria salva com sucesso!

No links

chevron-rightDELETE /categories / {id}hashtag

Parameters

Name
Description

id *

string(path)

id

Responses

Code
Description
Links

200

Categoria removida com sucesso!

No links

Trilhas

chevron-rightPOST / tracks / {id}hashtag

Parameters

Name
Description

id *

string(path)

id

Responses

Code
Description
Links

200

Trilha salva com sucesso!

No links

Tracks

chevron-rightDELETE/tracks/{id}hashtag

Parameters

Name
Description

id *

number(path)

id

Responses

Code
Description
Links

204

Trilha removida com sucesso!

No links

Tipos de conteúdo

chevron-rightPOST / content-types / {id}hashtag

Parameters

Name
Description

id *

number(path)

id

Responses

Code
Description
Links

200

Tipo de conteúdo criado com sucesso!

No links

Last updated

Was this helpful?