Introduction Glossaire Guide utilisateur 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 Convertisseur PDF en image Courriers Entités Export et fiche de liaison Groupes Notes Dossiers Pièces jointes Recherche Types de courrier Utilisateurs

Types de courrier

Arborescence complète des typologies de courrier

Route

GET /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 Identifiant du type de courrier
description string description du type de courrier
Exemple
{
  "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",
      "action_current_use": "transfer",
      "duration_current_use": 12,
      "id": 101,
      "text": "Abonnements – documentation – archives",
      "parent": "secondlevel_1",
      "icon": "fa fa-copy"
    },
    {...}
  ]
}

Liste des types de courrier

Route

GET /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
duration_current_use string Durée d'utilité courante
action_current_use string Action finale
retention_rule string Règle de conservation
Exemple
{
  "doctypes": [
    {
      "type_id": 1792,
      "description": "sdf",
      "enabled": "Y",
      "doctypes_first_level_id": 141,
      "doctypes_second_level_id": 124,
      "retention_final_disposition": "conservation",
      "retention_rule": "test",
      "duration_current_use": 1,
      "process_delay": 1,
      "delay1": 1,
      "delay2": 1,
      "process_mode": "NORMAL",
      "action_current_use": "destruction"
    },
    {...}
  ]
}

Création d'un type de courrier

Route

POST /rest/doctypes/types

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
description string Oui Description
doctypes_second_level_id int Oui Sous-chemise
process_delay int Oui Délai de traitement
delay1 int Oui Delai relance 1
delay2 int Oui Delai relance 2
process_mode string Oui Mode de traitement
duration_current_use int Non Durée d'utilité courante
action_current_use string Non Action finale
retention_final_disposition string Non Sort final des courriers ayant ce type de document
retention_rule string Non Règle de conservation
Exemple
{
    "description" : "Convocation",
    "doctypes_second_level_id" : 1,
    "process_delay" : 30,
    "delay1" : 2,
    "delay2" : 10,
    "process_mode" : "NORMAL"
}

Retour

Code Http Type Description Exemple
200 array Le type de courrier a bien été créé ['doctypeId' => 21]
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Modification d'un type de courrier

Route

PUT /rest/doctypes/types/{id}

Le paramètre id correspond à l'identifiant technique (doctypes.type_id) du type de courrier

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
description string Oui Description
doctypes_second_level_id int Oui Sous-chemise
process_delay int Oui Délai de traitement
delay1 int Oui Delai relance 1
delay2 int Oui Delai relance 2
process_mode string Oui Mode de traitement
duration_current_use int Non Durée d'utilité courante
action_current_use string Non Action finale
retention_final_disposition string Non Sort final des courriers ayant ce type de document
retention_rule string Non Règle de conservation
Exemple
{
    "description" : "Convocation",
    "doctypes_second_level_id" : 1,
    "process_delay" : 30,
    "delay1" : 2,
    "delay2" : 10,
    "process_mode" : "NORMAL"
}

Retour

Code Http Type Description Exemple
200 array Le type de courrier a bien été modifié [...]
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Suppression d'un type de courrier

Route

DELETE /rest/doctypes/types/{id}

Le paramètre id correspond à l'identifiant technique (doctypes.type_id) du type de courrier

Retour

Code Http Type Description Exemple
200 array Le type de courrier a bien été supprimé [...]
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Création d'une chemise

Route

POST /rest/doctypes/firstLevel

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
doctypes_first_level_label string Oui Nom de la chemise
enabled string Non Y Indique si la chemise est activée (Y) ou non (N)
Exemple
{
    "doctypes_first_level_label" : "Courriers"
}

Retour

Code Http Type Description Exemple
200 array La chemise a bien été créée ['firstLevelId' => 21, 'doctypeTree' => []
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Création d'une sous-chemise

Route

POST /rest/doctypes/secondLevel

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
doctypes_second_level_label string Oui Nom de la sous-chemise
doctypes_first_level_id int Oui Identifiant technique de la chemise
enabled string Non Y Indique si la sous-chemise est activée (Y) ou non (N)
Exemple
{
    "doctypes_second_level_label" : "Correspondances",
    "doctypes_first_level_id" : 21
}

Retour

Code Http Type Description Exemple
200 array La sous-chemise a bien été créée ['secondLevelId' => 31, 'doctypeTree' => []
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

results matching ""

    No results matching ""