Introduction Glossaire Guide utilisateur Guide administrateur fonctionnel Guide administrateur technique Prérequis pour Maarch Courrier Installation Script de migration 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 Attachments Contacts Notes Resources Types de courrier Reconciliation

Types de courrier

Récupération de l'arborescence complète

Route

GET /doctypes
Exemple
// URL
http://localhost/cs_maarch/rest/doctypes

Retour

Code Http Type Description Exemple
200 array Informations liées aux types de courrier ['structure' => '[...]']
Données
Valeur Type Description
structure array Arborescence des types de courriers

Données structure

Valeur Type Description
doctypes_first_level_id int Identifiant du premier niveau
doctypes_first_level_label string Label du premier niveau
doctypes_second_level_id int Identifiant du second niveau
doctypes_second_level_label string Label du second niveau
type_id int Identifint du type de courrier
description string description du type de courrier
Exemple
// JSON
{
  "structure": [
    {
      "doctypes_first_level_id": 1,
      "doctypes_first_level_label": "COURRIERS",
      "css_style": "#000000",
      "enabled": "Y",
      "id": "firstlevel_1",
      "text": "COURRIERS",
      "parent": "#",
      "state": {
        "opened": true
      }
    },
    {
      "doctypes_second_level_id": 2,
      "doctypes_second_level_label": "02. Cabinet",
      "doctypes_first_level_id": 1,
      "css_style": "#000000",
      "enabled": "Y",
      "id": "secondlevel_2",
      "text": "02. Cabinet",
      "parent": "firstlevel_1"
    },
    {
      "coll_id": "letterbox_coll",
      "type_id": 101,
      "description": "Abonnements – documentation – archives",
      "enabled": "Y",
      "doctypes_first_level_id": 1,
      "doctypes_second_level_id": 1,
      "retention_final_disposition": "destruction",
      "retention_rule": "compta_3_03",
      "duration_current_use": 12,
      "id": 101,
      "text": "Abonnements – documentation – archives",
      "parent": "secondlevel_1",
      "icon": "fa fa-copy"
    },
    {
      "coll_id": "letterbox_coll",
      "type_id": 801,
      "description": "Aide à domicile",
      "enabled": "Y",
      "doctypes_first_level_id": 1,
      "doctypes_second_level_id": 8,
      "retention_final_disposition": "destruction",
      "retention_rule": "compta_3_03",
      "duration_current_use": 12,
      "id": 801,
      "text": "Aide à domicile",
      "parent": "secondlevel_8",
      "icon": "fa fa-copy"
    }
  ]
}

Récupération des types de courrier

Route

GET /doctypes/types
Exemple
// URL
http://localhost/cs_maarch/rest/doctypes/types

Retour

Code Http Type Description Exemple
200 array Informations liées aux types de courrier ['doctypes' => '[...]']
Données
Valeur Type Description
doctypes array Arborescence des types de courriers

Données doctypes

Valeur Type Description
type_id int Identifiant du type de courrier
description string Label du type de courrier
doctypes_first_level_id int Identifiant du premier niveau auquel est rattaché le type de courrier
doctypes_second_level_id int Identifiant du second niveau auquel est rattaché le type de courrier
retention_final_disposition string Sort final des courriers ayant ce type de document
retention_rule string Règle de conservation
duration_current_use string Identifiant du second niveau auquel est rattaché le type de courrier
Exemple

// JSON
{
  "doctypes": [
    {
      "coll_id": "letterbox_coll",
      "type_id": 102,
      "description": "Convocation",
      "enabled": "Y",
      "doctypes_first_level_id": 1,
      "doctypes_second_level_id": 1,
      "retention_final_disposition": "destruction",
      "retention_rule": "compta_3_03",
      "duration_current_use": 12
    },
    {
      "coll_id": "letterbox_coll",
      "type_id": 101,
      "description": "Abonnements – documentation – archives",
      "enabled": "Y",
      "doctypes_first_level_id": 1,
      "doctypes_second_level_id": 1,
      "retention_final_disposition": "destruction",
      "retention_rule": "compta_3_03",
      "duration_current_use": 12
    },
    {
      "coll_id": "letterbox_coll",
      "type_id": 103,
      "description": "Demande de documents",
      "enabled": "Y",
      "doctypes_first_level_id": 1,
      "doctypes_second_level_id": 1,
      "retention_final_disposition": "destruction",
      "retention_rule": "compta_3_03",
      "duration_current_use": 12
    },
    {
      "coll_id": "letterbox_coll",
      "type_id": 104,
      "description": "Demande de fournitures et matériels",
      "enabled": "Y",
      "doctypes_first_level_id": 1,
      "doctypes_second_level_id": 1,
      "retention_final_disposition": "destruction",
      "retention_rule": "compta_3_03",
      "duration_current_use": 12
    }
  ]
}

results matching ""

    No results matching ""