Schemas: modules
Schemas whose first using operation belongs to the modules family. A shared schema is described once, here, and linked from every operation that uses it.
Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.
AccessReason
Pourquoi un module est dans son etat. CONTRAT STABLE (ADR-0067).
Type : string
Allowed values : 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
Used by : modulesCatalogue
ActivationRequestOut
Demande d'activation consignee cote institution.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
id | string (uuid) | yes | ||
module | ModuleId | yes | ||
requested_at | string (date-time) | yes | ||
requested_by | string (uuid) | yes | ||
status | ActivationRequestStatus | yes | ||
transmitted_to_control | false | no | Aucun circuit ne transmet encore une demande a CONTROL (ADR-0067). | default: false |
withdrawn_at | string (date-time) | null | yes | ||
withdrawn_by | string (uuid) | null | yes |
Used by : modulesCatalogue, modulesRequestActivation, modulesWithdrawActivationRequest
ActivationRequestStatus
Etat d'une demande d'activation faite par l'institution.
Type : string
Allowed values : pending, withdrawn
Used by : modulesCatalogue, modulesRequestActivation, modulesWithdrawActivationRequest
ModuleCatalogueOut
Catalogue de l'institution : onze modules, et ses demandes.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
modules | array<ModuleOut> | yes | ||
requests | array<ActivationRequestOut> | yes |
Used by : modulesCatalogue
ModuleOut
Un module, tel que la garde de l'API le traite pour cette institution.
Type : object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
contractual | boolean | yes | Droit contractuel. Faux pour une ouverture de pilote, toujours. | |
family | "socle" | "extension" | yes | ||
module | ModuleId | yes | ||
open | boolean | yes | Ouvert a l'usage ; la permission reste exigee. | |
pending_request_id | string (uuid) | null | yes | ||
reason | AccessReason | yes | ||
requestable | boolean | yes | Une demande d'activation est possible. | |
state | ModuleState | yes |
Used by : modulesCatalogue
ModuleState
Etat effectif d'un module pour une institution. CONTRAT STABLE (ADR-0067).
Type : string
Allowed values : unavailable, preview, pilot_enabled, subscribed, suspended
Used by : modulesCatalogue