L'envoi d'un pli numérique¶

Initialiser¶

GET /rest/messageExchangesInitialization?resId={resId}

Paramètres¶

Nom	Emplacement	Type	Obligatoire	Description
`resId`	query	integer	Non	Identifiant du courrier principal. Si fourni, la réponse indique aussi si un retour peut être envoyé.

Réponse 200¶

{
  "entities": [
    {
      "id": "PJS",
      "label": "Pole juridique",
      "m2m": "FR-MC-PJS"
    }
  ],
  "canSendReturn": true
}

canSendReturn est présent uniquement si resId est fourni.

Envoyer un pli numérique¶

POST /rest/resources/{resId}/messageExchange

Droits¶

L'utilisateur doit avoir le privilège manage_numeric_package.
Le courrier {resId} doit être dans le périmètre de l'utilisateur.

Paramètres¶

Nom	Emplacement	Type	Obligatoire	Description
`resId`	path	integer	Oui	Identifiant du courrier principal.
`sendReturn`	query	boolean	Non	Si `true`, déclenche l'envoi d'un retour au lieu d'un pli classique.

Corps JSON pour un pli classique¶

{
  "object": "Transmission du dossier",
  "content": "Bonjour, veuillez trouver le pli numérique.",
  "contacts": [123],
  "senderEmail": "PJS",
  "status": "WAITING",
  "isExpectingReturn": true,
  "mainExchangeDoc": "res_letterbox__42",
  "joinFile": [42],
  "joinAttachment": [201, 202],
  "notes": [301]
}

Champs du pli classique¶

Nom	Type	Obligatoire	Description
`object`	string	Oui	Objet du pli.
`content`	string	Non	Corps du message.
`contacts`	array	Oui	Identifiants des contacts destinataires.
`senderEmail`	string	Oui	Identifiant de l'entité émettrice M2M.
`isExpectingReturn`	boolean	Non	Si `true`, le destinataire doit supporter le retour Maarch2Maarch.
`mainExchangeDoc`	string	Oui	Ressource principale du pli, au format `res_letterbox__{id}`, `res_attachments__{id}` ou `notes__{id}`.
`joinFile`	array	Non	Identifiants des fichiers joints au pli principal.
`joinAttachment`	array	Non	Identifiants des pièces jointes ajoutées au pli.
`notes`	array	Non	Identifiants des notes ajoutées au pli.

Corps JSON pour un retour¶

Utiliser le même endpoint avec ?sendReturn=true.

POST /rest/resources/{resId}/messageExchange?sendReturn=true

{
  "content": "Retour des pièces demandées.",
  "contacts": [123],
  "senderEmail": "PJS",
  "resourcesToBeReturned": [
    "res_letterbox__42",
    "attachment__201"
  ],
  "notes": [301]
}

Champs du retour¶

Nom	Type	Obligatoire	Description
`content`	string	Non	Corps du message.
`contacts`	array	Oui	Doit contenir exactement un destinataire.
`senderEmail`	string	Oui	Identifiant de l'entité émettrice M2M.
`resourcesToBeReturned`	array	Oui	Ressources retournées, au format `res_letterbox__{id}` ou `attachment__{id}`.
`notes`	array	Non	Identifiants des notes ajoutées au retour.

Les champs joinFile, joinAttachment et mainExchangeDoc sont interdits pour un retour.

Réponses¶

200 OK : pli créé, sauvegardé et envoi lancés.
400 Bad Request : corps invalide.
403 Forbidden : privilège insuffisant ou courrier hors périmètre.
500 Internal Server Error : erreur technique locale ou erreur retournée par l'instance distante pendant l'appel curl.