Schémas : modules

Schémas dont la première opération qui les emploie appartient à la famille modules. Un schéma partagé est décrit une seule fois, ici, et lié depuis toutes les opérations qui l'emploient.

Les descriptions viennent du contrat, rédigé en français. Elles sont reproduites telles quelles pour rester la source de vérité.

`AccessReason`

Pourquoi un module est dans son etat. CONTRAT STABLE (ADR-0067).

Type : string

Valeurs admises : not_delivered, not_commercially_available, not_activated_on_instance, institution_suspended, contractual, not_governed, pilot_opening, not_subscribed, perimeter_not_started, perimeter_ended, pilot_ended

Employé par : modulesCatalogue

`ActivationRequestOut`

Demande d'activation consignee cote institution.

Type : object

Propriété	Type	Requis	Description	Contraintes
`id`	`string (uuid)`	oui
`module`	`ModuleId`	oui
`requested_at`	`string (date-time)`	oui
`requested_by`	`string (uuid)`	oui
`status`	`ActivationRequestStatus`	oui
`transmitted_to_control`	`false`	non	Aucun circuit ne transmet encore une demande a CONTROL (ADR-0067).	default: false
`withdrawn_at`	`string (date-time) \| null`	oui
`withdrawn_by`	`string (uuid) \| null`	oui

Employé par : modulesCatalogue, modulesRequestActivation, modulesWithdrawActivationRequest

`ActivationRequestStatus`

Etat d'une demande d'activation faite par l'institution.

Type : string

Valeurs admises : pending, withdrawn

Employé par : modulesCatalogue, modulesRequestActivation, modulesWithdrawActivationRequest

`ModuleCatalogueOut`

Catalogue de l'institution : onze modules, et ses demandes.

Type : object

Propriété	Type	Requis	Description	Contraintes
`modules`	`array<ModuleOut>`	oui
`requests`	`array<ActivationRequestOut>`	oui

Employé par : modulesCatalogue

`ModuleOut`

Un module, tel que la garde de l'API le traite pour cette institution.

Type : object

Propriété	Type	Requis	Description
`contractual`	`boolean`	oui	Droit contractuel. Faux pour une ouverture de pilote, toujours.
`family`	`"socle" \| "extension"`	oui
`module`	`ModuleId`	oui
`open`	`boolean`	oui	Ouvert a l'usage ; la permission reste exigee.
`pending_request_id`	`string (uuid) \| null`	oui
`reason`	`AccessReason`	oui
`requestable`	`boolean`	oui	Une demande d'activation est possible.
`state`	`ModuleState`	oui

Employé par : modulesCatalogue

`ModuleState`

Etat effectif d'un module pour une institution. CONTRAT STABLE (ADR-0067).

Type : string

Valeurs admises : unavailable, preview, pilot_enabled, subscribed, suspended

Employé par : modulesCatalogue