Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AuthApiController
  • /auth/qr
  • GET POST
Controller for authorizations.
PersonApiController
  • /person
  • /person/{id}
  • GET PATCH POST
  • DELETE GET PATCH
Controller for the person API.
SystemApiController
  • /system/locale
  • /system/locales
  • GET PUT
  • GET
Controller for system API's.
UserApiController
  • /user
  • /user/{id}
  • GET POST PUT
  • DELETE GET
API Controller for the User object.

Data Types

JSON

type description
AbstractUser
GeoLocation The current GEO Location.
MobileDevice A mobile device bound to an user.
Person Identifying a person.
QrData The object holding the QR data. Object is required for completing the authorization process.
Role The user roles.
SystemLocale A single system locale object.
User User model. (Database annotations)