Position Green API: År

Ändrad den Mån, 9 juni vid 3:55 E.M.

Detta är ett objekt som representerar ett rapporteringsår i Position Green. Den skapas av en Controller i Setup. Året har ett start- och ett slutdatum, de behöver inte vara desamma som ett kalenderår eller ens 365 dagar. Överlappande år är tillåtna.

Års-ID används för att ställa frågor till andra resurser för att identifiera vilket år uppgifterna begärs för.

Egenskaper för ett år-objekt

Egendom	Datatyp	Beskrivning
id	Vägledning	Årets id
namn	sträng	Årets namn (kan innehålla bokstäver)
startDatum	sträng	Startdatum (ISO 8601, ååååå-mm-dd)
slutDatum	sträng	Slutdatum (ISO 8601, ååååå-mm-dd)
standard	bool	Om året är det förvalda året för Rapportörerna
synligt	bool	Om året är synligt för Rapportörer
låsta	bool	Inga ändringar av uppgifterna är tillåtna.

Hämta alla år

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

Avkastning alla år

Parametrar för förfrågan

Namn	Ämne	Beskrivning
första	heltal	Begränsar antalet år i resultatet. Förvalt 10. Minst 1 och högst 1000.
efter	sträng	Markör som pekar på var man ska fortsätta hämta år.
sortera efter	sträng	"EndDate" eller "Name". EndDate är förvalt.
sortDirection	sträng	"Stigande" eller "Fallande". Stigande är förvalt.

{
    "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",
                "förvalt": false,
                "synlig": true,
                "låst": false
            }
        },
        {
            "cursor": "aWR4OzE=",
            "node": {
                "id": "b424be42-90a6-45b3-9b41-c04c196bab20",
                "name": "2018",
                "startDate": "2018-01-01",
                "endDate": "2018-12-31",
                "förvalt": false,
                "synlig": true,
                "låst": true
            }
        },
        {
            "cursor": "aWR4OzI=",
            "node": {
                "id": "f4e14d1d-0e1f-4f67-8466-8bfb156d704a",
                "name": "2019",
                "startDate": "2019-01-01",
                "endDate": "2019-12-31",
                "förvalt": false,
                "synlig": true,
                "låst": true
            }
        },
        {
            "cursor": "aWR4OzM=",
            "node": {
                "id": "e821339f-9d6d-4f0e-9d0b-6452396befbd",
                "name": "2020",
                "startDate": "2020-01-01",
                "endDate": "2020-12-31",
                "förvalt": true,
                "synlig": true,
                "låst": false
            }
        }
    ]
}

Exempel: få de första 2 åren med användning av curl

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