Versions Compared

Version Old Version 7 New Version Current
Changes made by

Gerben

Planning.nl

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

De OData API is nog in beta. De API is nog in ontwikkeling en kan mogelijk nog veranderen .

...

Authenticatie

Huidige ondersteunde vormen van authenticatie zijn:

  • HTTP basic authenticatie
    Deze vorm werkt met een gebruikersnaam en wachtwoord.

  • X-API-KEY in http header
    Het API token dat hiervoor nodig is kan een applicatiebeheerder genereren

Andere vormen van authenticatie worden in de toekomst mogelijk nog toegevoegd.
Een applicatiebeheerder kan de authenticatie in en uitschakelen en je de rechten geven voor toegang tot (een deel van) de data.
Een gebruiker van de API heeft dezelfde rechten als in de webapplicatie.

Gebruik

Informatie voor het gebruik van OData (vooral voor ontwikkelaars) is vooral te vinden op odata.org.
De Planning.nl OData API ondersteunt het ophalen van geneste data mbv de odata navigationproperties en de $expand parameter.
Gebruik dit om met 1 http request data uit meerdere tabellen teglijk op te halen. Zoals een project en informatie over bijbehorende relatie en projecttype.
Er is momenteel geen beperking aan het aantal geneste niveaus.

Info

Deze documentatie zal nog worden uitgebreid met voorbeelden voor gebruik in excel, powerbi en postman

Adressen / voorbeelden

...

Adres

...

https://app.planning.nl/OData/V1

...

Dit is de (base) URL van de OData API.

...

  1. https://app.planning.nl/OData/V1/projects

  2. https://app.planning.nl/OData/V1/projects(1)

  3. https://app.planning.nl/OData/V1/projects?$filter=Start gt 2023-01-01T00:00:00Z

  4. https://app.planning.nl/OData/V1/projects?$filter=Start gt 2023-01-01T00:00:00Z and ProjectTypeEntity/Description eq 'Maintanance'

...

  1. Voorbeeld URL voor het ophalen van (alle) projecten

  2. Voorbeeld URL voor het ophalen van een project met id 1.

  3. Voorbeeld URL voor ophalen alle projecten die starten na 1 jan 2023

  4. Voorbeeld URL voor ophalen alle projecten die starten na 1 jan 2023 en zijn van projecttype = onderhoud

Info

Let op het gebruik van hoofdletters. De OData API van Planning.nl is hoofdlettergevoelig.
De juiste schrijfwijze van een veldnaaam/property en entityset (tabel) is altijd te vinden in de metadata of in het info document.

...

Informatiepagina met een overzicht van alle tabelen en velden in de OData API.
In dit overzicht zijn ook de namen van de extra velden (properties) en de namen van de extra tabellen te zien als die gebruikt worden.
Dit is een geaggregeerd overizcht van de informatie die ook in de OData metadata beschikbaar is.

...

Documentatie over de OData API is te vinden op:

https://github.com/Planning-nl/app-api-documentation