In CASHWeb maakt een API-request het mogelijk om interactie te hebben met API, waardoor je toegang krijgt tot verschillende functionaliteiten en gegevens van binnen het systeem.
API-requests kunnen verschillende soorten operaties uitvoeren, zoals het ophalen van gegevens, het toevoegen van nieuwe gegevens, het bijwerken van bestaande gegevens of het verwijderen ervan, afhankelijk van de functionaliteit die wordt aangeboden door de API. Dit maakt het mogelijk om systemen en applicaties met elkaar te verbinden en gegevens uit te wisselen op een gestandaardiseerde en gecontroleerde manier.
Met API-requests kunnen ontwikkelaars en systemen met elkaar communiceren, waardoor integratiemogelijkheden ontstaan.
De requests zijn gebaseerd op een recordnummer in de CASH Database. Recordindelingen en veldnummers zijn terug te vinden in;
Een API-request werkt naast recordindelingen en veldnummers ook met een serie aan (optionele) eigenschappen.
De argumenten worden gescheiden door | (pipeteken).
- Argument 1 bevat het recordnummer, optioneel met eigenschap-letter;
- Argument 2 bevat de sleutel van een bepaald record;
- Argument 3 bevat de tweede sleutel van een bepaald record of de t/m waarde van een serie.
Voorbeeld: 9999X|ARG2|ARG3
Eigenschappen Argument1
- Argument 1 bevat het primaire indexnummer van het gewenste record.
Voorbeeld: 101 = record en index 101 (relaties); - Voorloopletter I (hoofdletter i, van Index) leest een record met een secondaire index.
Voorbeeld: I103 = record 101, index 103 (Postcode relatie); - Extensie achter een recordnummer leest een record op basis van een specifieke eigenschap.
Voorbeeld: 101V = record 101 met totaalbedrag vervallen debiteurenposten.
Algemeen argument (optioneel)
- X : xml inclusief namen velden, bedoeld tbv. testmode
- E : voor het mee geven van een sleutel, waarmee 1 enkel record wordt opgevraagd
(ARG2 wordt niet als van-t/m waarde gebruikt) alleen in combinatie met I voor export op index.
Voor specifieke eigenschappen verwijzen we je naar de onderstaande artikelen;