Guide administrateur fonctionnel
Guide administrateur technique
Prérequis pour Maarch Courrier
Installation
Breaking Change
Exploitation
Mise en oeuvre de docker
Architecture technique
Architecture du produit
Architecture d'un projet type
Description du modèle de données
Description des webservices
Bannettes
Contacts
Courriers
Entités
Export et fiche de liaison
Groupes
Notes
Dossiers
Pièces jointes
Recherche
Types de courrier
Utilisateurs
Search
Recherche de courrier
Route
POST /rest/search
Paramètres
Body
Tous les champs listés ci-dessous sont des objets (object) ayant l'attribut "values".
"values" peut contenir une simple chaine de caractères (string) ou un tableau (array).
Dans le cas d'un tableau, le type de valeur autorisée est indiqué entre parenthèses.
| Valeur | Type | Obligatoire | Description |
|---|---|---|---|
| meta | string | Non | Champ de recherche rapide (Recherche sur le sujet (courrier / pièce jointe), numéro chrono (courrier / pièce jointe), code à barre, numéro GED (courrier)) |
| subject | string | Non | Sujet du courrier ou d'une pièce jointe |
| doctype | array (int) | Non | Identifiant du type du courrier (Voir l'administration des typologies) |
| chrono | string | Non | Numéro chrono du courrier ou d'une pièce jointe |
| barcode | string | Non | Code barre du courrier |
| resId | array (int) | Non | Identifiant du courrier |
| categoryId | array (string) | Non | Catégorie du courrier |
| status | array (int) | Non | Statut du courrier |
| priority | array (string) | Non | Identifiant de la priorité (Voir l'administration des priorités) |
| confidentiality | array (bool) | Non | Confidentialité du courrier |
| destination | array (int) | Non | Identifiant de l'entité traitante du courrier (Voir l'administration des entités) |
| initiator | array (int) | Non | Identifiant de l'entité initiatrice du courrier (Voir l'administration des entités) |
| creationDate | array (date) | Non | Date de création du courrier |
| documentDate | array (date) | Non | Date du courrier |
| arrivalDate | array (date) | Non | Date d'arrivée du courrier |
| departureDate | array (date) | Non | Date de départ du courrier |
| processLimitDate | array (date) | Non | Date limite de traitement du courrier |
| closingDate | array (date) | Non | Date de cloture du courrier |
| senders | array (contact) | Non | Expéditeur(s) (peut être un contact, un utilisateur ou une entité) |
| recipients | array (contact) | Non | Destinataires(s) (peut être un contact, un utilisateur ou une entité) |
| folders | array (int) | Non | Identifiants des dossiers |
| tags | array (int) | Non | Identifiants des mot-clés |
| notes | string | Non | Mots compris dans une note |
| attachment_type | array (int) | Non | Types de pièces jointes |
| attachment_creationDate | array (date) | Non | Date de création d'une pièce jointe |
| groupSign | array (int) | Non | Groupe d'un signataire d'une pièce jointe |
| senderDepartment | array (string) | Non | Département d'un expéditeur |
| fulltext | string | Non | Recherche plein texte |
| role_* | array (contact) | Non | Roles dans les diffèrentes listes ou circuit (dest, avis, visa...) |
| indexingCustomField_* | array (dépend du type de custom) | Non | Champs personalisés |
| registeredMail_reference | string | Non | Référence courrier recommandé |
| registeredMail_issuingSite | array (int) | Non | Site émetteur courrier recommandé |
| registeredMail_receivedDate | array (date) | Non | Date de réception courrier recommandé |
| registeredMail_recipient | array (ban) | Non | Destinataire courrier recommandé |
Exemple
{
"doctype" : {"values" : [102, 103, 104]},
"subject" : {"values" : "test"},
"resId" : {"values" : {"start" : 150, "end" : 200}},
"documentDate" : {"values" : {"start" : "2020-01-01", "end" : "2020-10-31"}},
"role_dest" : {"values" : [{"id" : 10, "type" : "user"}]},
"senders" : {"values" : [{"id" : 10, "type" : "contact"}, {"id" : 24, "type" : "user"}]},
"indexingCustomField_3" : {"values" : "test"}
}
Retour
| Code Http | Type | Description | Exemple |
|---|---|---|---|
| 200 | array | Résultats de la recherche | ['resources' => [...], ...] |
400 |
array | Configuration admin manquante | ['errors' => '...'] |
500 |
array | Une erreur s'est produite | ['errors' => '...'] |
Exemple de retour :
{
"resources": [
{
"resId": 580,
"chrono": "MAARCH/2019A/37",
"barcode": null,
"subject": "Test",
"confidentiality": "N",
"statusLabel": "A e-signer",
"statusImage": "fm-file-fingerprint",
"priorityColor": "#eebe1a",
"closing_date": "2020-01-23 15:46:20.503071",
"countAttachments": 2,
"hasDocument": true,
"mailTracking": false,
"integrations": {
"inShipping": true,
"inSignatureBook": true
},
"retentionFrozen": false,
"binding": null,
"countNotes": 2,
"folders": [],
"display": [],
"inAttachments": false
}, {...}
],
"count": 2,
"allResources": [
580
],
"defaultTab": "visaCircuit",
"displayFolderTags": false,
"templateColumns": 2,
"filters": {...}
}