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 Pièces jointes Bannettes Contacts Entités Export et fiche de liaison Groupes Notes Courriers Utilisateurs Types de courrier

Création d'une entité

Route

POST /rest/entities

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
entity_id string Oui Identifiant
entity_label string Oui Description
short_label string Oui Description courte
entity_type string Oui Type d'entité
adrs_1 string Non Adresse 1
adrs_2 string Non Adresse 2
adrs_3 string Non Adresse 3
zipcode string Non Code postal
city string Non Ville
country string Non Pays
email string Non email
business_id string Non Siret de l'entité
parent_entity_id string Non Identifiant parent de l'entité
Exemple
{
    "entity_id" : "PJ",
    "entity_label" : "Police judiciaire",
    "short_label" : "PJ",
    "entity_type" : "Service",
    "parent_entity_id" : "PO"
}

Retour

Code Http Type Description Exemple
200 array Donnée enregistrée ['entities' => [] ]
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'une entité

Route

PUT /rest/entities/{id}

Le paramètre id de la route représente l'identifiant (string) de l'entité à modifier

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
entity_label string Oui Description
short_label string Oui Description courte
entity_type string Oui Type d'entité
adrs_1 string Non Adresse 1
adrs_2 string Non Adresse 2
adrs_3 string Non Adresse 3
zipcode string Non Code postal
city string Non Ville
country string Non Pays
email string Non email
business_id string Non Siret de l'entité
parent_entity_id string Non Identifiant parent de l'entité
Exemple
{
    "entity_label" : "Police judiciaire",
    "short_label" : "PJ",
    "entity_type" : "Service"
}

Retour

Code Http Type Description Exemple
200 array Donnée enregistrée
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' => '...']

Suppression d'une entité

Route

DELETE /rest/entities/{id}

Le paramètre id de la route représente l'identifiant (string) de l'entité à supprimer

Retour

Code Http Type Description Exemple
200 array La modification a bien été prise en compte
400 array ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Liste des entités

Route

GET /rest/entities

Retour

Code Http Type Description Exemple
200 array liste des entités ["entities" => [] ]
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Création d'une liste de diffusion, d'un circuit de visa ou d'avis pour l'entité

Route

POST /rest/listTemplates?admin=true

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
entityId int Oui Identifiant technique de l'entité
type string Oui Type de la liste
title string Oui Titre
description string Oui Description
items string Oui Eléments de la liste
Exemple
{
    "entityId" : 15,
    "type" : "diffusionList",
    "title" : "Liste PJ",
    "description" : "Liste de diffusion PJ",
    "items" : [
        {
            "id" : 3,
            "type" : "user",
            "mode" : "dest"
        },
        {
            "id" : 16,
            "type" : "user",
            "mode" : "cc"
        },
        {
            "id" : 8,
            "type" : "entity",
            "mode" : "cc"
        }
    ]
}

{
    "entityId" : 15,
    "type" : "visaCircuit",
    "title" : "Circuit de visa PJ",
    "description" : "Circuit de visa PJ",
    "items" : [
        {
            "id" : 3,
            "type" : "user",
            "mode" : "visa"
        },
        {
            "id" : 16,
            "type" : "user",
            "mode" : "visa"
        },
        {
            "id" : 22,
            "type" : "user",
            "mode" : "sign"
        }
    ]
}

{
    "entityId" : 15,
    "type" : "opinionCircuit",
    "title" : "Circuit d'avis PJ",
    "description" : "Circuit d'avis PJ",
    "items" : [
        {
            "id" : 3,
            "type" : "user",
            "mode" : "avis"
        },
        {
            "id" : 16,
            "type" : "user",
            "mode" : "avis"
        },
        {
            "id" : 22,
            "type" : "user",
            "mode" : "avis"
        }
    ]
}

Retour

Code Http Type Description Exemple
200 array Donnée enregistrée ['id' => 2 ]
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'une liste de diffusion, d'un circuit de visa ou d'avis pour l'entité

Route

PUT /rest/listTemplates/{id}

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
title string Oui Titre
description string Non Description
items string Oui Eléments de la liste
Exemple
{
    "title" : "Liste PJ modifié",
    "description" : "Liste de diffusion PJ modifié",
    "items" : [
        {
            "id" : 3,
            "type" : "user",
            "mode" : "dest"
        },
        {
            "id" : 8,
            "type" : "entity",
            "mode" : "cc"
        }
    ]
}

{
    "title" : "Circuit de visa PJ v2",
    "description" : "Circuit de visa PJ v2",
    "items" : [
        {
            "id" : 3,
            "type" : "user",
            "mode" : "visa"
        },
        {
            "id" : 22,
            "type" : "user",
            "mode" : "sign"
        }
    ]
}

{
    "title" : "Circuit d'avis PJ v2",
    "description" : "Circuit d'avis PJ v2",
    "items" : [
        {
            "id" : 3,
            "type" : "user",
            "mode" : "avis"
        },
        {
            "id" : 22,
            "type" : "user",
            "mode" : "avis"
        }
    ]
}

Retour

Code Http Type Description Exemple
204 array Donnée enregistrée
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' => '...']

Suppression d'une liste de diffusion, d'un circuit de visa ou d'avis pour l'entité

Route

DELETE /rest/listTemplates/{id}

Retour

Code Http Type Description Exemple
204 array Donnée enregistrée
400 array ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

results matching ""

    No results matching ""