Grunder
Tillåtna HTTP-verb är GET, PATCH, POST och DELETE. Här är detaljerade beskrivningar av anropstyperna:
GET: Hämta data från Severa
PATCH: Uppdatera befintlig data
JSON Patch är formatet som används för att uppdatera data i REST API (mer information på: http://jsonpatch.com/).
Endast Replace (ersätt) stöds.
POST: Skapa ny data i Severa
DELETE: Ta bort data från Severa.
Använd med försiktighet, eftersom borttagna data tas bort helt
Svarskoder för anrop är Success, Created och Bad request
Paginering
Som standard hämtas 20 rader per GET-anrop, och max är 1000. Parametrarna är firstRow och rowCount. Rekommenderas att användas vid tunga anrop.
Text sökning
Parametern textToSearch kan användas för snabb sökning. Till exempel i GET/users anropet finns en parameter för att söka i användarens namn, kod, e-post eller nyckelord. För varje rutt är fälten som sökningen utförs på definierade i den tekniska dokumentationen.
Sortering
Definierad i många GET all for rutter som en frågeparameter. Den stöder att ge flera värden. Exempel:
?sortings[0]
[key]=lastUpdatedDateTime&sortings[0]
[value]=Desc&sortings[1]
[key]=createdDateTime&sortings[1]
[value]=Asc
Changed since
Parameter för att hämta data från ett visst datum och framåt. Med denna parameter kan du hämta data som har ändrats efter det angivna datumet. Till exempel i GET/users anropet finns en ChangedSince-parameter för att få användare som har lagts till eller ändrats efter detta datum (större eller lika med).
Omfattningar (Scopes)
För närvarande används endast SeveraAll, men omfattningar kommer att läggas till när de implementeras.