Skip to content

GitLab

Last edited by Jurjen Brouwer
Page history
This is an old version of this page. You can view the most recent version or browse the history.

App API

Create

Create a new app for the user that has authenticated itself.

https://portal.robotsindeklas.nl/API/v1/app/create

Parameters:

  • name: the new name of the app
  • type: presentation, blocklykids, code, calc
  • tags (optional):
  • settings (optional):

Info

Get the document of a particular app.

https://portal.robotsindeklas.nl/API/v1/app/info

Parameter:

  • app: the object id of the app you want the info of

Copy

Create a copy of an existing app.

https://portal.robotsindeklas.nl/API/v1/app/copy

Parameters:

  • app: the object id of the app you want to copy
  • name (optional): the new name of the copied app

Lock

Lock an app. If an app is locked, users with play or edit rights will no longer have access to the content of the app.

https://portal.robotsindeklas.nl/API/v1/app/lock

Parameters:

  • app, string: the object id of the app you want to lock
  • lock, boolean, (optional, default: false): lock (true) or unlock (false) this app

Share

Share an app with a user or group. We define four levels of share rights:

  • 0 (revoked rights): user or group will no longer have access to this app
  • 1 (play rights): user or group will be able to only play this app, but not edit it or share it further with other users.
  • 2 (edit rights): user or group will be able to play and edit this app, but won't be able to share it further with other users.
  • 3 (admin rights): user or group will be able to play, edit and share this app with other users.
https://portal.robotsindeklas.nl/API/v1/app/share

Parameters:

  • app: the object id of the app you want to share
  • level: 0,1,2,3
  • oid: the object id of the user or group we want the share this app with

Trash

Remove an app or bring it back from the trash bin.

https://portal.robotsindeklas.nl/API/v1/app/trash

Parameters:

  • app: the object id of the app we want to trash
  • del (boolean): delete (true) or restore (false) deleted item

Send

Send a copy of an app to another user.

https://portal.robotsindeklas.nl/API/v1/app/send

Parameters:

  • app: the object id of the app we want to send
  • send (array): the object id of the user or group we want the send a copy of the app to

Assign

Assign a basic (basis) program to a set of users or groups. When assigning a basic program, the users receiving the app will be able to make the assignment but not see the answer.

https://portal.robotsindeklas.nl/API/v1/app/assign

Parameters:

  • app: the object id of the app we want to trash
  • oid (string): the id of a user or group we want to share this app with
  • assign (boolean): assign or remove assignment

Link

Link an agenda to a robot.

https://portal.robotsindeklas.nl/API/v1/app/link

Parameters:

  • app: the object id of the app we want to link
  • send (array): list of robot ids we want to link this app with // TODO why list?
  • link (boolean): link (true) or de-link (false)