Position API verte : Années

Modifié le Lun, 24 Nov. à 12:44 H

Il s'agit d'un objet représentant une année de référence dans Position Green. Il est créé par un contrôleur dans la configuration. L'année a une date de début et une date de fin, qui ne doivent pas nécessairement correspondre à l'année civile ni même à 365 jours. Les années qui se chevauchent sont autorisées.

L'identifiant de l'année est utilisé pour interroger d'autres ressources afin d'identifier l'année pour laquelle les données sont demandées.

Propriétés d'un objet année

Propriété	Type de données	Description
id	Guide	Identifiant de l'année
nom	chaîne	Nom de l'année (peut contenir des lettres)
date de début	chaîne	Date de début (ISO 8601, aaaa-mm-jj)
date de fin	chaîne	Date de fin (ISO 8601, aaaa-mm-jj)
par défaut	bool	Si l'année est l'année par défaut pour les reporters
visible	bool	Si l'année est visible pour les journalistes
verrouillé	bool	Aucune modification des données n'est autorisée.

Obtenir toutes les années

GET 
https://api.positiongreen.com/v1/years

Renvoie toutes les années

Paramètres de requête

Nom	Type	Description
premier	entier	Limite le nombre d'années dans le résultat. Par défaut 10. Minimum 1 et maximum 1000.
après	chaîne	Curseur indiquant où poursuivre la récupération des années.
trier par	chaîne	« EndDate » ou « Name ». EndDate est la valeur par défaut.
sortDirection	chaîne	« Ascendant » ou « Descendant ». L'ascension est le réglage par défaut.

{
    "totalCount": 4,
    "pageInfo": {
        "hasNextPage": false,
        "startCursor": "aWR4OzA=",
        "endCursor": "aWR4OzM="
    },
    "items": [
        {
            "cursor": « aWR4OzA= »,
            « node » : {
                « id » : « a689f723-ee83-4bd7-a186-bbd9aee9e8f2 »,
                « name » : « 2017 »,
                « startDate » : « 2017-01-01 »,
                « endDate » : « 2017-12-31 »,
                « default » : false,
                « visible » : true,
                « locked » : false
            }
        },
        {
            "cursor": "aWR4OzE=",
            "node": {
                "id": "b424be42-90a6-45b3-9b41-c04c196bab20",
                "name": "2018",
                "startDate": "2018-01-01",
                "endDate": "2018-12-31",
                "default": false,
                "visible": true,
                "locked": true
            }
        },
        {
            "cursor": "aWR4OzI=",
            "node": {
                "id": "f4e14d1d-0e1f-4f67-8466-8bfb156d704a",
                "name": "2019",
                "startDate": "2019-01-01",
                "endDate": "2019-12-31",
                "default": false,
                "visible": true,
                "locked": true
            }
        },
        {
            "cursor": "aWR4OzM=",
            "node":{
                "id": "e821339f-9d6d-4f0e-9d0b-6452396befbd",
                "name": "2020",
                "startDate": "2020-01-01",
                "endDate": "2020-12-31",
                "default": true,
                "visible": true,
                "locked": false
            }
        }
    ]
}

Exemple : récupération des deux premières années à l'aide de curl

curl --request GET --header 'Authorization: Bearer <access token>' '<api-url>/years?first=