Consulter la structure d’une organisation
Comment consulter les communautés qui composent l’organisation ?
Avec le GET /communities
|
curl 'https://api.steeple.com/v1/communities' \ --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2ODMyXXX2MTYsInN1YiI6ImYzNjU0ODgwLTM0YzAtNGQ4Yi04OWU4LWEzNGU2MTE1YTM3NSJ9.eOpVocgU1Pzapnj3iFc6RzqWi3V63_xnXEb_AwDF-dx' |
Avec pour réponse :
|
{ "data": [ { "id": "3570x3dc-c994-4e02-83ax-89b9c52f79de", "name": "Commu #1" }, { "id": "ax9360f-3ca5-4axe-9fe3-0020600be67f", "name": "Commu #2" }, { "id": "bea39x22-c395-48x6-b804-b0c428346c08", "name": "Commu #3" } ], "meta": { "pagination": { "total": 3, "page": 1, "per_page": 20 } } } |
Pour chaque communauté du bloc data :
|
clé |
Description |
|
id |
Id Steeple de la communauté |
|
name |
nom de la communauté |
Le bloc meta est composé de :
|
clé |
Description |
|
pagination.total |
nombre total de communautés de l’organisation |
|
pagination.page |
page courante des communautés retournées dans la réponse |
|
pagination.per_page |
nombre de communautés retournées par page |
Paramètres de requête disponibles
|
clé |
Description |
|
page |
permet de naviguer dans les résultats (par défaut, page=1) |
|
per_page |
modifie le nombre de communautés retournées par page (par défaut, per_page=20) |
Consulter les catégories/sous-catégories des communautés d’une organisation
Comment consulter les catégories/sous-catégories ?
Avec le GET /categories
|
curl 'https://api.steeple.com/v1/categories' \ --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2ODMyXXX2MTYsInN1YiI6ImYzNjU0ODgwLTM0YzAtNGQ4Yi04OWU4LWEzNGU2MTE1YTM3NSJ9.eOpVocgU1Pzapnj3iFc6RzqWi3V63_xnXEb_AwDF-dx' |
Avec pour réponse :
|
{ "data": [ { "title": "Communication interne", "groups": [ { "id": "86cf55b4-8a4b-41xx-9a0c-b1d751cd2e8a", "title": "Actualités" }, { "id": "210f36d3-3bf9-4axx-bf22-7b01b3c5b692", "title": "RH" }, { "id": "e8bed1ad-150a-42xx-9074-4ce7069a3bb3", "title": "La vie du site" }, { "id": "c8d0747c-358d-49xx-ad82-4c3582542198", "title": "Affichage réglementaire" } ] } ], "meta": { "pagination": { "total": 6, "page": 1, "per_page": 1 } } } |
Pour chaque catégorie du bloc data :
|
clé |
Description |
|
title |
nom de la catégorie |
|
groups |
liste des sous-catégories |
Pour chaque sous-catégories d’un bloc groups :
|
clé |
Description |
|
id |
Id Steeple de la sous-catégorie |
|
name |
nom de la sous-catégorie |
Le bloc meta est composé de :
|
clé |
Description |
|
pagination.total |
nombre total de catégorie de l’organisation |
|
pagination.page |
page courante des catégorie retournées dans la réponse |
|
pagination.per_page |
nombre de catégorie retournées par page |
Paramètres de requête disponibles
|
clé |
Description |
|
community_ids[] |
Critère de filtre sur les identifiants des communautés de l’organisation (par défaut, absent). Paramètre cumulable pour obtenir les catégories de plusieurs communautés d’une même organisation. Si absent, les catégories de toutes les communautés confondues seront retournées. Voir Comment consulter les communautés qui composent l’organisation ? pour obtenir les identifiants des communautés pour la mise en place des filtres. |
|
page |
permet de naviguer dans les catégories (par défaut, page=1) |
|
per_page |
modifie le nombre de catégories retournées par page (par défaut, per_page=20) |
Cas d’usage
Récupérer les catégories/sous-catégories d’une communauté spécifique de l’organisation :
|
curl 'https://api.steeple.com/v1/categories?community_ids[]=bea39d22-c395-48xx-b804-b0c428346c08' \ --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2ODMyXXX2MTYsInN1YiI6ImYzNjU0ODgwLTM0YzAtNGQ4Yi04OWU4LWEzNGU2MTE1YTM3NSJ9.eOpVocgU1Pzapnj3iFc6RzqWi3V63_xnXEb_AwDF-dx' |