| ... | ... | @@ -6,9 +6,12 @@ https://portal.robotsindeklas.nl/API/v1/app/create |
|
|
|
|
|
|
|
Parameters:
|
|
|
|
- **name**, *string*: the new name of the app
|
|
|
|
- **type**, *string*: presentation, blocklykids, code, calc
|
|
|
|
- **tags** (optional):
|
|
|
|
- **settings** (optional):
|
|
|
|
- **type**, *string*: the type of the app. Currently available:
|
|
|
|
- blocklykids: a simple basic app where most of the programming blocks consist out of icons;
|
|
|
|
- presentation: an advanced app where you could create presentations;
|
|
|
|
- code: an advanced+ app where you could learn how to use functions and variables;
|
|
|
|
- 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.
|
|
|
|
|
|
|
|
### Info
|
|
|
|
Get the document of a particular app.
|
| ... | ... | @@ -17,7 +20,7 @@ https://portal.robotsindeklas.nl/API/v1/app/info |
|
|
|
```
|
|
|
|
|
|
|
|
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
|
|
|
|
Create a copy of an existing app.
|
| ... | ... | @@ -26,8 +29,8 @@ https://portal.robotsindeklas.nl/API/v1/app/copy |
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
- **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
|
|
|
|
- **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.
|
|
|
|
|
|
|
|
### 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.
|
| ... | ... | @@ -36,8 +39,8 @@ 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
|
|
|
|
- **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:
|
| ... | ... | @@ -52,9 +55,9 @@ https://portal.robotsindeklas.nl/API/v1/app/share |
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
- **app**, *string*: the object id of the app you want to share
|
|
|
|
- **level**, *int*: 0,1,2,3
|
|
|
|
- **oid**, *string*: the object id of the user or group we want the share this app with
|
|
|
|
- **app**, *string*: the object id of the app you want to share;
|
|
|
|
- **level**, *int*: the share level we want to assign to the user or group with this request;
|
|
|
|
- **oid**, *string*: the object id of the user or group we want the share this app with.
|
|
|
|
|
|
|
|
|
|
|
|
### Trash
|
| ... | ... | @@ -64,8 +67,8 @@ https://portal.robotsindeklas.nl/API/v1/app/trash |
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
- **app**, *string*: the object id of the app we want to trash
|
|
|
|
- **del**, *boolean*: delete (true) or restore (false) deleted item
|
|
|
|
- **app**, *string*: 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.
|
| ... | ... | @@ -74,8 +77,8 @@ https://portal.robotsindeklas.nl/API/v1/app/send |
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
- **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
|
|
|
|
- **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.
|
|
|
|
|
|
|
|
### 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.
|
| ... | ... | @@ -84,9 +87,9 @@ https://portal.robotsindeklas.nl/API/v1/app/assign |
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
- **app**, *string*: 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
|
|
|
|
- **app**, *string*: 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.
|
| ... | ... | @@ -95,6 +98,6 @@ https://portal.robotsindeklas.nl/API/v1/app/link |
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
- **app**, *string*: the object id of the app we want to link
|
|
|
|
- **send**, *array\<string\>*: list of robot ids we want to link this app with // TODO why list?
|
|
|
|
- **link**, *boolean*: link (true) or de-link (false) |
|
|
\ No newline at end of file |
|
|
|
- **app**, *string*: the object id of the app we want to link;
|
|
|
|
- **send**, *array\<string\>*: list of robot ids we want to link this app with; // TODO why list?
|
|
|
|
- **link**, *boolean*: link (true) or de-link (false). |
|
|
\ No newline at end of file |
