Skip to main content
NEXCLARADocumentation

modules

The contract does not describe this family.

Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.

GET /api/v1/modules

Catalogue institutionnel des modules

Etat reel de chacun des onze modules pour l'institution, et ses demandes d'activation. Permission `modules.read`.

modulesCatalogue

Parameters

No parameters.

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonModuleCatalogueOut

POST /api/v1/modules/activation-requests/{request_id}/withdrawal

Retirer une demande d'activation

Retire une demande en attente.

modulesWithdrawActivationRequest

Parameters

ParameterLocationTypeRequiredConstraints
request_idpathstring (uuid)yes

Request body

No request body.

Responses

StatusDescriptionContent typeType
200Successful Responseapplication/jsonActivationRequestOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/modules/{module}/activation-requests

Demander l'activation d'un module

Consigne une demande pour un module decouvrable (`preview`). Elle n'active rien et n'est pas transmise a CONTROL. Permission `modules.request`.

modulesRequestActivation

Parameters

ParameterLocationTypeRequiredConstraints
modulepathModuleIdyes

Request body

No request body.

Responses

StatusDescriptionContent typeType
201Successful Responseapplication/jsonActivationRequestOut
422Validation Errorapplication/jsonHTTPValidationError