Bannettes

Création d'une bannette

Route

POST /rest/baskets

Paramètres

Body

Valeur	Type	Obligatoire	Valeur par défaut	Description
id	string	Oui		Identifiant
basket_name	string	Oui		Nom
basket_desc	string	Oui		Description
clause	string	Oui		Clause
color	string	Non		Couleur de la bannette sur la page d'accueil
isSearchBasket	boolean	Non	false	Indique si la bannette est uniquement utilisée pour le périmètre de la recherche
flagNotif	boolean	Non	false	Indique si les notifications de bannette sont activées sur cette bannette
basket_res_order	string	Non	'res_id desc'	Tri par défaut de la bannette

Exemple

{
    "id" : "AR_BASKET",
    "basket_name" : "Bannette d'AR",
    "basket_desc" : "Bannette servant aux AR",
    "clause"    : "status = 'ENV'",
    "color" : "#36c3e6"
}

Retour

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

Route

PUT /rest/baskets/{id}

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

Paramètres

Body

Valeur	Type	Obligatoire	Valeur par défaut	Description
basket_name	string	Oui		Nom
basket_desc	string	Oui		Description
clause	string	Oui		Clause
color	string	Non		Couleur de la bannette sur la page d'accueil
isSearchBasket	boolean	Non	false	Indique si la bannette est uniquement utilisée pour le périmètre de la recherche
flagNotif	boolean	Non	false	Indique si les notifications de bannette sont activées sur cette bannette
basket_res_order	string	Non	res_id DESC	Tri par défaut de la bannette

Exemple

{
    "basket_name" : "Bannette d'AR",
    "basket_desc" : "Bannette servant aux AR",
    "clause"    : "status = 'ENV'",
    "color" : "#36c3e6"
}

Retour

Code Http	Type	Description	Exemple
200	array	Donnée modifiée	['success' => 'success']
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 bannette

Route

DELETE /rest/baskets/{id}

Le paramètre id de la route représente l'identifiant (baskets.basket_id) de la bannette à 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 bannettes

Route

GET /rest/baskets

Retour

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

Exemple

{
    "baskets":[
    {
        "coll_id":"letterbox_coll",
        "basket_id":"CopyMailBasket",
        "basket_name":"Courriers en copie",
        "basket_desc":"Corbeille d'information",
        "basket_clause":"1=1",
        "is_visible":"Y",
        "enabled":"Y",
        "basket_order":8,
        "flag_notif":"N",
        "basket_res_order":"opinion_limit_date asc",
        "color":"#666666",
        "id":2
    },
    {...}
}