API - Read

Owned by Ron Kanters (Unlicensed)
Last updated: Oct 25, 2021
1 min read

Inleiding

API Beeyond - Read beschrijft de procedure voor het opvragen van gegevens middels API 1.0 en 1.1. De read API is bedoeld om de data van een specifiek record op te vragen. Het is niet mogelijk om bijvoorbeeld een lijst van artikelen op te vragen. Hiervoor kan de Search API gebruikt worden.

Voor het verkrijgen van toegang tot Beeyond API heb je een API toegang ID, een reguliere gebruiker en een Sleutel (Beeyond-Hash) nodig. Zie ook de pagina https://beeyondbv.atlassian.net/wiki/spaces/BUD/pages/807272457

 

Voorbeelden

Wat betreft het lezen van data uit Beeyond zijn er enkele mogelijkheden:

  • Case 1: In de header wordt de entiteit ID van Beeyond meegegeven. In dit geval ziet de body er iets simpeler uit. Het uitvragen van data kan alleen op basis van de primaire sleutel in Beeyond.

  • Case 2: In de header wordt de entiteit ID niet meegegeven. In dat geval wordt de entiteit ID in de body meegegeven.

  • Case 3: Opvragen van data waarbij ook inkomende relaties worden opgevraagd. In dit voorbeeld wordt de BTW tabel uitgelezen, waarbij Artikeldata de inkomende relatie betreft. Bij het uitlezen van de data wordt dus een BTW record uitgelezen, met de gekoppelde artikelen.

 

Aandachtspunten

  • Op dit moment krijg je altijd alle velden terug uit het opgevraagde record bij een Read call, je kan dus niet alleen specifieke velden uitlezen.