Skip to content

GitLab

App API · Changes

Page history
Update App API authored by Jurjen Brouwer's avatar Jurjen Brouwer
Hide whitespace changes
Inline Side-by-side
Showing with 11 additions and 4 deletions
App-API.md
View page @ 279af8f9
...@@ -13,6 +13,7 @@ Parameters: ...@@ -13,6 +13,7 @@ Parameters:
- calc: practice math exercises with the robot; - calc: practice math exercises with the robot;
- agenda: with the agenda app, you can let the robot say certain reminders at a pre-defined time. - agenda: with the agenda app, you can let the robot say certain reminders at a pre-defined time.
### Info ### Info
Get the document of a particular app. Get the document of a particular app.
``` ```
...@@ -22,6 +23,7 @@ https://portal.robotsindeklas.nl/API/v1/app/info ...@@ -22,6 +23,7 @@ https://portal.robotsindeklas.nl/API/v1/app/info
Parameter: Parameter:
- **app**, *string*: the object id of the app you want the info of. - **app**, *string*: the object id of the app you want the info of.
### Copy ### Copy
Create a copy of an existing app. Create a copy of an existing app.
``` ```
...@@ -32,8 +34,9 @@ Parameters: ...@@ -32,8 +34,9 @@ Parameters:
- **app**, *string*: the object id of the app you want to copy; - **app**, *string*: the object id of the app you want to copy;
- **name**, *string*, (optional, default: name of the original app): the new name of the copied app. - **name**, *string*, (optional, default: name of the original app): the new name of the copied app.
### Lock ### 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. Lock an app. If an app is locked, users with play or edit share rights will no longer have access to the content of the app.
``` ```
https://portal.robotsindeklas.nl/API/v1/app/lock https://portal.robotsindeklas.nl/API/v1/app/lock
``` ```
...@@ -42,12 +45,13 @@ Parameters: ...@@ -42,12 +45,13 @@ Parameters:
- **app**, *string*: the object id of the app you want to lock; - **app**, *string*: the object id of the app you want to lock;
- **lock**, *boolean*, (optional, default: false): lock (true) or unlock (false) this app. - **lock**, *boolean*, (optional, default: false): lock (true) or unlock (false) this app.
### Share ### Share
Share an app with a user or group. We define four levels of share rights: 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 - 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. - 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. - 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. - 3 (admin rights): user or group will be able to play, edit and share this app with other users.
``` ```
...@@ -70,6 +74,7 @@ Parameters: ...@@ -70,6 +74,7 @@ Parameters:
- **app**, *string*: the object id of the app we want to trash; - **app**, *string*: the object id of the app we want to trash;
- **del**, *boolean*: delete (true) or restore (false) deleted item. - **del**, *boolean*: delete (true) or restore (false) deleted item.
### Send ### Send
Send a copy of an app to another user. Send a copy of an app to another user.
``` ```
...@@ -80,6 +85,7 @@ Parameters: ...@@ -80,6 +85,7 @@ Parameters:
- **app**, *string*: the object id of the app we want to send; - **app**, *string*: the object id of the app we want to send;
- **send**, *array\<string\>*: the object id of the user or group we want the send a copy of the app to. - **send**, *array\<string\>*: the object id of the user or group we want the send a copy of the app to.
### Assign ### 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. 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.
``` ```
...@@ -91,6 +97,7 @@ Parameters: ...@@ -91,6 +97,7 @@ Parameters:
- **oid**, *string*: the id of a user or group we want to share this app with; - **oid**, *string*: the id of a user or group we want to share this app with;
- **assign**, *boolean*: assign or remove assignment. - **assign**, *boolean*: assign or remove assignment.
### Link ### Link
Link an agenda to a robot. Link an agenda to a robot.
``` ```
......