...

OneRoster har specifierat två olika typer av interaktioner. Dels en asynkron batchorientera överföring av CSV-filer och dels ett REST-API.

REST-API

APIet är specificerat som ett traditionellt REST-API och bygger på HTTP som protokoll och JSON som format.

De definierad REST-resurserna inom OneRoster är grupperade i tre grupper; Rosterning, Resources och Gradebook. Inom respektive grupp är det specificerat vilka REST-resurser som ingår i respektive grupp samt vilka HTTP-metoder som ska stödjas för respektive resurs. Noterbart är att man enbart specificerat implementation av GET-metoden för samtliga resurse inom gruppen Rostering. OneRoaster-specifikation inkluderar vilka säkerhetsmekanisker som ska implementeras som del av APIet. Av integritets skäl ska Transaction Layer Security (TLS) användas samt OAUTH för autentisering och signering.

...