Aller au contenu principal
NEXCLARADocumentation

trust

Le contrat ne décrit pas cette famille.

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

GET /api/v1/applications/{application_id}/consents

Consentements du demandeur d'un dossier

Etat par finalite active et historique ; la lecture est journalisee (P56).

applicationsConsents

Paramètres

ParamètreEmplacementTypeRequisContraintes
application_idpathstring (uuid)oui

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonApplicantConsentsOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/applications/{application_id}/consents

Enregistrer un recueil ou un retrait de consentement

Evenement de consentement, avec la reference de sa piece (`consents.record`).

applicationsRecordConsent

Paramètres

ParamètreEmplacementTypeRequisContraintes
application_idpathstring (uuid)oui

Corps de la requête

Type de contenu
application/json
Type
ConsentIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
201Successful Responseapplication/jsonApplicantConsentsOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/trust/compliance-report

Rapport de conformite

Cinq sections calculees sur la periode, sous `audit.read`.

trustComplianceReport

Paramètres

ParamètreEmplacementTypeRequisContraintes
startquerystring (date)oui
endquerystring (date)oui

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonComplianceReportOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/trust/compliance-report/export

Exporter le rapport de conformite en preuve signee

`nexclara-compliance-report@1`, signe par la cle d'instance si configuree.

trustExportComplianceReport

Paramètres

ParamètreEmplacementTypeRequisContraintes
startquerystring (date)oui
endquerystring (date)oui

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Preuve canonique, a verifier hors du service.application/jsonEvidenceBundleOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/trust/consent-purposes

Finalites de consentement

Versions de finalite, actives et retirees.

trustListPurposes

Paramètres

Aucun paramètre.

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonarray<ConsentPurposeOut>

POST /api/v1/trust/consent-purposes

Definir une finalite (nouvelle version)

Nouvelle version ; la version active du meme code est retiree (`trust.configure`).

trustCreatePurpose

Paramètres

Aucun paramètre.

Corps de la requête

Type de contenu
application/json
Type
ConsentPurposeIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
201Successful Responseapplication/jsonConsentPurposeOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/trust/consent-purposes/{purpose_id}/retire

Retirer une finalite

Retire une version active ; les consentements donnes demeurent.

trustRetirePurpose

Paramètres

ParamètreEmplacementTypeRequisContraintes
purpose_idpathstring (uuid)oui

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonConsentPurposeOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/trust/data-rights

Demandes de droits

Demandes, recentes d'abord, filtrees par etat.

trustListRightsRequests

Paramètres

ParamètreEmplacementTypeRequisContraintes
statusquery"open" | "awaiting_purge" | "completed" | "refused" | nullnon

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonarray<RightsRequestOut>
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/trust/data-rights

Enregistrer une demande d'exercice de droits

Demande enregistree, echeance fixee ; la reference presentee n'est pas conservee.

trustRegisterRightsRequest

Paramètres

Aucun paramètre.

Corps de la requête

Type de contenu
application/json
Type
RightsRequestIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
201Successful Responseapplication/jsonRightsRequestOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/trust/data-rights/{request_id}

Une demande

Une demande et son echeance.

trustGetRightsRequest

Paramètres

ParamètreEmplacementTypeRequisContraintes
request_idpathstring (uuid)oui

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonRightsRequestOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/trust/data-rights/{request_id}/accept-erasure

Accepter un effacement

Effacement accepte : la prochaine purge l'execute, l'atteste et clot la demande.

trustAcceptErasure

Paramètres

ParamètreEmplacementTypeRequisContraintes
request_idpathstring (uuid)oui

Corps de la requête

Type de contenu
application/json
Type
RightsTransitionIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonRightsRequestOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/trust/data-rights/{request_id}/access-report

Emettre le releve d'acces et clore la demande

`nexclara-subject-access-report@1`, signe ; la demande est close.

trustAccessReport

Paramètres

ParamètreEmplacementTypeRequisContraintes
request_idpathstring (uuid)oui

Corps de la requête

Type de contenu
application/json
Type
AccessReportIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
200Preuve canonique, a verifier hors du service.application/jsonEvidenceBundleOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/trust/data-rights/{request_id}/complete-rectification

Clore une rectification faite a la source

La donnee a ete corrigee dans le systeme de l'institution ; NEXCLARA ne la reecrit pas.

trustCompleteRectification

Paramètres

ParamètreEmplacementTypeRequisContraintes
request_idpathstring (uuid)oui

Corps de la requête

Type de contenu
application/json
Type
RightsTransitionIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonRightsRequestOut
422Validation Errorapplication/jsonHTTPValidationError

POST /api/v1/trust/data-rights/{request_id}/refuse

Refuser une demande, motif code

Refus avec un motif de la liste fermee ; aucun texte libre.

trustRefuseRightsRequest

Paramètres

ParamètreEmplacementTypeRequisContraintes
request_idpathstring (uuid)oui

Corps de la requête

Type de contenu
application/json
Type
RefusalIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonRightsRequestOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/trust/purge-runs

Executions de purge

Executions recentes d'abord : comptes, empreinte de l'attestation.

trustPurgeRuns

Paramètres

Aucun paramètre.

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonarray<PurgeRunOut>

GET /api/v1/trust/purge-runs/{run_id}/attestation

Telecharger une attestation de destruction

`nexclara-destruction-attestation@1`, octets tels qu'emis et signes.

trustPurgeAttestation

Paramètres

ParamètreEmplacementTypeRequisContraintes
run_idpathstring (uuid)oui

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Preuve canonique, a verifier hors du service.application/jsonEvidenceBundleOut
422Validation Errorapplication/jsonHTTPValidationError

GET /api/v1/trust/retention

Durees de conservation

Durees en vigueur (provisoires ou confirmees) et elements echus.

trustRetention

Paramètres

Aucun paramètre.

Corps de la requête

Aucun corps de requête.

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonRetentionOut

PUT /api/v1/trust/retention/{category}

Confirmer une duree de conservation

Confirme une duree (authentification renforcee) : la purge s'y appliquera.

trustConfirmRetention

Paramètres

ParamètreEmplacementTypeRequisContraintes
categorypathRetentionCategoryoui

Corps de la requête

Type de contenu
application/json
Type
RetentionIn
Requis
oui

Réponses

StatutDescriptionType de contenuType
200Successful Responseapplication/jsonRetentionOut
422Validation Errorapplication/jsonHTTPValidationError