Accusés de réception¶

Les accusés de réception sont associés à un courrier. Les routes de cette page exigent l'authentification REST et l'accès au courrier concerné.

Lister les accusés de réception d'un courrier¶

Cette action retourne les accusés de réception associés à un courrier visible par l'utilisateur connecté.

GET /rest/resources/{resId}/acknowledgementReceipts

Authentification, privilège et périmètre¶

L'authentification REST est obligatoire. Le courrier doit appartenir au périmètre de l'utilisateur. Aucun privilège fonctionnel supplémentaire n'est contrôlé pour appeler la route.

Le privilège view_confidential_contact_information détermine si la valeur des adresses électroniques confidentielles est présente dans la réponse.

Paramètre d'URL¶

Valeur	Type	Obligatoire	Description
`resId`	integer	Oui	Identifiant du courrier.

Retours¶

Code HTTP	Type	Description	Exemple
`200`	array	Accusés de réception du courrier.	Voir l'exemple.
`403`	object	`resId` n'est pas un entier ou le courrier est hors périmètre.	`{"errors":"Document out of perimeter"}`

Chaque élément retourné contient les données suivantes.

Valeur	Type	Description
`id`	integer	Identifiant de l'accusé de réception.
`resId`	integer	Identifiant du courrier.
`type`	string	Type d'accusé de réception enregistré.
`format`	string	Format du document.
`userId`	integer	Identifiant de l'utilisateur créateur.
`userLabel`	string	Libellé de l'utilisateur créateur.
`creationDate`	string	Date de création enregistrée.
`sendDate`	string ou null	Date d'envoi enregistrée.
`contact`	object	Destinataire principal.
`cc`	array	Destinataires en copie.
`cci`	array	Destinataires en copie cachée.

[
  {
    "id": 42,
    "resId": 124,
    "type": "simple",
    "format": "pdf",
    "userId": 19,
    "userLabel": "Barbara BAIN",
    "creationDate": "2026-08-06 10:30:00",
    "sendDate": null,
    "contact": {
      "firstname": "Jean",
      "lastname": "DUPONT",
      "company": "Maarch",
      "email": {
        "confidential": false,
        "value": "jean.dupont@example.org"
      },
      "labelToDisplay": "Jean DUPONT",
      "id": 8
    },
    "cc": [],
    "cci": []
  }
]

Pour une adresse confidentielle, la propriété email.value est absente lorsque l'utilisateur ne possède pas le privilège view_confidential_contact_information.

Consulter un accusé de réception¶

Cette action retourne les métadonnées d'un accusé de réception.

GET /rest/acknowledgementReceipts/{id}

Authentification, privilège et périmètre¶

L'authentification REST est obligatoire. Le courrier associé doit appartenir au périmètre de l'utilisateur. Le privilège view_confidential_contact_information régit l'affichage des adresses électroniques confidentielles.

Paramètre d'URL¶

Valeur	Type	Obligatoire	Description
`id`	integer	Oui	Identifiant de l'accusé de réception.

Retours et erreurs¶

Code HTTP	Type	Description	Exemple
`200`	object	Objet `acknowledgementReceipt` dont la structure est celle d'un élément de la liste précédente.	`{"acknowledgementReceipt":{"id":42,"resId":124,"type":"paper","format":"pdf"}}`
`400`	object	`id` n'est pas un entier.	`{"errors":"Route param id is not an integer"}`
`400`	object	L'accusé de réception n'existe pas.	`{"errors":"Acknowledgement receipt does not exist"}`
`403`	object	Le courrier associé est hors périmètre.	`{"errors":"Document out of perimeter"}`

Télécharger le contenu d'un accusé de réception¶

Cette action retourne le contenu encodé en Base64 et son format.

GET /rest/acknowledgementReceipts/{id}/content

Authentification, privilège et périmètre¶

L'authentification REST est obligatoire. Aucun privilège fonctionnel supplémentaire n'est contrôlé, mais le courrier associé doit appartenir au périmètre de l'utilisateur.

Paramètre d'URL¶

Valeur	Type	Obligatoire	Description
`id`	integer	Oui	Identifiant de l'accusé de réception.

Retours et erreurs¶

Code HTTP	Type	Description	Exemple
`200`	object	Contenu Base64 et format du document.	`{"encodedDocument":"JVBERi0xLjQK...","format":"pdf"}`
`400`	object	L'accusé de réception n'existe pas.	`{"errors":"Acknowledgement receipt does not exist"}`
`400`	object	Le docserver n'existe pas.	`{"errors":"Docserver does not exist"}`
`400`	object	L'empreinte du fichier ne correspond pas.	`{"errors":"Fingerprints do not match"}`
`403`	object	Le courrier associé est hors périmètre.	`{"errors":"Document out of perimeter"}`
`404`	object	Le fichier est absent du docserver.	`{"errors":"Document not found on docserver"}`

Générer le PDF des accusés de réception papier¶

Cette action concatène les accusés de réception papier non envoyés correspondant aux identifiants fournis et retourne le PDF obtenu.

POST /rest/acknowledgementReceipts

Authentification, privilège et périmètre¶

L'authentification REST est obligatoire. Aucun privilège fonctionnel supplémentaire n'est contrôlé. Tous les courriers associés aux accusés de réception trouvés doivent appartenir au périmètre de l'utilisateur.

Body JSON¶

Valeur	Type	Obligatoire	Description
`resources`	array d'integer	Oui	Identifiants des accusés de réception. L'api ne traite pas plus de 500 valeurs.

{
  "resources": [42, 43]
}

Retours et erreurs¶

Code HTTP	Type	Description	Exemple
`200`	binaire	PDF retourné en ligne avec le nom `maarch.pdf`.	Non applicable.
`400`	object	Le docserver n'existe pas.	`{"errors":"Docserver does not exist"}`
`400`	object	Une empreinte de fichier ne correspond pas.	`{"errors":"Fingerprints do not match"}`
`403`	object	`resources` est absent ou vide.	`{"errors":"Resources is not set or empty"}`
`403`	object	Au moins un courrier est hors périmètre.	`{"errors":"Documents out of perimeter"}`
`404`	object	Un fichier est absent du docserver.	`{"errors":"Document not found on docserver"}`

Seuls les accusés de réception sans date d'envoi et dont le format enregistré est pdf sont ajoutés au document retourné.