13.3 Liste des attributs énumérés

13.3.1 URL

GET /api/v1/families/<famName>/enumerates/

Récupére la liste des énumérés de la famille <famname>.

13.3.2 Content

Le contenu de la requête est vide.

13.3.3 Structure de retour

Le retour est une donnée JSON.

13.3.3.1 En cas de réussite :

{
    "success": true,
    "messages": [],
    "data": {
        "uri": "http://www.example.net/api/v1/families/DIR/enumerates/",
        "enumerates": [
            {
                "attributeId": "gui_isrss",
                "label": "Utilisable comme flux RSS",
                "uri": "http://www.example.net/api/v1/families/DIR/enumerates/gui_isrss.json"
            },
            {
                "attributeId": "gui_sysrss",
                "label": "Flux RSS système",
                "uri": "http://www.example.net/api/v1/families/DIR/enumerates/gui_sysrss.json"
            },
            {
                "attributeId": "fld_allbut",
                "label": "tout ou rien",
                "uri": "http://www.example.net/api/v1/families/DIR/enumerates/fld_allbut.json"
            },
            {
                "attributeId": "fld_subfam",
                "label": "restriction sous famille",
                "uri": "http://www.example.net/api/v1/families/DIR/enumerates/fld_subfam.json"
            }
        ]
    }
}

L'api retourne une liste d'énumérés (enumerates) chacun des éléments contient :

l'URI permettant d'accéder à la liste des valeurs,
le label de l'attribut énuméré dans la langue de l'utilisateur appelant,
le nom logique de l'attribut énuméré.

13.3.3.2 En cas d'échec

Les raisons d'échecs spécifiques à cette requête sont

Raison	Status HTTP	Error Code
Famille non trouvée	404	API0220

Exemple :

{
    "success": false,
    "messages": [
        {
            "type": "error",
            "contentText": "Document \"NOT_A_FAMILY\" not found",
            "code": "API0200"
        },
        {
            "type": "message",
            "contentText": "You can consult http://www.example.net/index.php?app=HTTPAPI_V1 to have info on the API",
            "contentHtml": "You can consult <a href=\"http://www.example.net/index.php?app=HTTPAPI_V1\">the REST page</a> to have info on the API"
        }
    ],
    "data": null,
    "exceptionMessage": "Document \"NOT_A_FAMILY\" not found"
}

13.3.4 Filtres

13.3.4.1 Slice

Cette option indique le nombre de valeur maximum à retourner.

Exemple :

GET api/v1/families/<famName>/enumerates/?slice=10

13.3.4.2 Offset

Index à partir duquel, les énumérés sont retournées.

Exemple:

GET api/v1/families/<famName>/enumerates/?slice=2&offset=7

Source : enum/get_enum_list.md Dynacase Platform 3.2 | API HTTP Core Manuel de référence, version 1.0 édition 3, © Anakeen Labs <labs@anakeen.com>