Skip to content

KB REST API - CRUD Funktioner

De mest oplagte funktioner er læsning og skrivning direkte af tabeller. Her findes forskellige mulighder. Det er ikke sikkert at alle er tilladte, men overordren findes der

Hent en Liste - GET /Varer/

En GET direkte på URL'en vil returnere en liste af poster GET (https://test.keybalance.dk/KB/api2/50229EA9-A883-45DD-A19F-D7ACCACB1891/Varer)

Eksempel på svar: 

{
    "rows": [
        {
            "id": ["1"],
            "VNummer": "1",
            "Søgenavn": "",
            "Varenavn": "Varenavn Vare 1",
            ...
        },
        {
            "id": [
                "10"
            ],
            "VNummer": "10",
            "Søgenavn": "",
            "Varenavn": "Varenavn 10",
            ...
        }
    ]
}

Parametre

Kaldet til listen kan finpudses med disse generelle funktioner

  • Size=xx - Begræns listen til xx poster
  • After = - Hent kun poster EFTER kriteriet
  • FilterBy = - Angiv evt kriterium for posterne

Hent én post - GET /Varer/{id}

Ved at tilføje det unkikke id for en post, hentes kun den post. Det er dette element der skal bruges ved at oprette/rette/slette poster.

GET (https://test.keybalance.dk/KB/api2/50229EA9-A883-45DD-A19F-D7ACCACB1891/Varer/10)

Eksempel på svar: 

{
            "id": [
                "10"
            ],
            "VNummer": "10",
            "Søgenavn": "",
            "Varenavn": "Varenavn 10",
            ...
}

Opdater én post - PUT /Varer/{id}

Opdatering af en post er et PUT af den tilpassede JSON til den samme URL.

  • id-feltet bliver ignoreret, da det specikke id er med i URL'en. Det er muligt at ændre fx Varenummer via dette kald - men det skal gøres med omtanke.

  • Felter der IKKE er med i payload vil blive ignoreret. For at tømme et felt skal det være med, men med tom værdi "".

  • Alle regler i ERP systemet bliver valideret, fx gyldigt GLN nummer og at varenavn SKAL være udfyldt

  • Bemærk at beregnede felter naturligvis ikke kan ændres. Fx Vare.Beholdning

PUT https://test.keybalance.dk/KB/api2/50229EA9-A883-45DD-A19F-D7ACCACB1891/Varer/10

Eksempel på Payload: 

{
            "VNummer": "10",
            "Varenavn": "Nyt varenavn",
            ...
}

Opret ny post - POST /Varer/

At oprette en post, er at lave en POST direkte på tabellen. Der bruges samme payload som returneres for EN record. Opdatering af en post er et PUT af den tilpassede JSON til den samme URL.

  • ID Felter vil ofte være required, men de kan også have automatisk nummerering.

  • Felter der IKKE er med i payload vil blive ignoreret. For at tømme et felt skal det være med, men med tom værdi "".

  • Alle regler i ERP systemet bliver valideret, fx gyldigt GLN nummer og at varenavn SKAL være udfyldt

  • Bemærk at beregnede felter naturligvis ikke kan sættes. Fx Vare.Beholdning

POST https://test.keybalance.dk/KB/api2/50229EA9-A883-45DD-A19F-D7ACCACB1891/Varer

Eksempel på Payload: 

{
            "VNummer": "NytNr",
            "Varenavn": "Ny-Oprettet varenavn",
            ...
}

Slet én post - DELETE /Varer/{id}

Et delete kald direkte på den specifikke URL vil forsøge en sletning. Alle slettekrav i KeyBalance ERP vil naturligvis blive kontrolleret. Så ved komplekse tabeller KAN der være noget ventetid.

DELETE https://test.keybalance.dk/KB/api2/50229EA9-A883-45DD-A19F-D7ACCACB1891/Varer/10