Position Green API: Jahre

Geändert am Do, 17 Jul um 6:59 NACHMITTAGS

Dieses Objekt stellt ein Berichtsjahr in Position Green dar. Es wird von einem Controller im Setup erstellt. Das Jahr hat ein Anfangs- und ein Enddatum, die jedoch nicht mit einem Kalenderjahr übereinstimmen oder gar 365 Tage ergeben müssen. Überschneidende Jahre sind zulässig.

Die ID des Jahres wird für die Abfrage anderer Ressourcen verwendet, um festzulegen, für welches Jahr die Daten angefordert werden.

Eigenschaften eines Jahresobjekts

Eigenschaft	Datenart	Beschreibung
id	Guid	ID des Jahres
name	String	Bezeichnung des Jahres (kann Buchstaben enthalten)
startDate	String	Anfangsdatum (ISO 8601, JJJJ-MM-TT)
endDate	String	Enddatum (ISO 8601, JJJJ-MM-TT)
default	bool	Wenn das Jahr das Standardjahr für die Berichterstatter ist
visible	bool	Wenn das Jahr für Berichterstatter sichtbar ist
locked	bool	Eine Änderung der Daten ist nicht zulässig.

Alle Jahre abrufen

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

Gibt alle Jahre aus

Abfrageparameter

Bezeichnung	Art	Beschreibung
first	ganze Zahl	Begrenzt die Anzahl der Jahre im Ergebnis. Standardeinstellung = 10. Mindestens 1 und höchstens 1000
after	String	Cursor für die Stelle, an der die Jahresabfrage fortgesetzt werden soll
sortBy	String	"EndDate" oder "Name". Standardeinstellung = EndDate
sortDirection	String	"Aufsteigend" oder "Absteigend". Standardeinstellung = Aufsteigend

{
    "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
            }
        }
    ]
}

Beispiel: Abfrage der ersten 2 Jahre mittels curl

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