App-API.md

@@ -5,8 +5,8 @@ https://portal.robotsindeklas.nl/API/v1/app/create
 ```
 
 Parameters:
-- **name**, *string*: the new name of the app
-- **type**, *string*: the type of the app. Currently available:
+- **name** - *string*: the new name of the app
+- **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;
@@ -21,7 +21,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
@@ -31,8 +31,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
@@ -42,8 +42,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
@@ -59,9 +59,9 @@ https://portal.robotsindeklas.nl/API/v1/app/share
 ```
 
 Parameters:
-- **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.
+- **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
@@ -71,8 +71,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
@@ -82,8 +82,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
@@ -93,9 +93,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
@@ -105,6 +105,41 @@ 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).
+
+
+### Response
+If the request was successful, you will receive the following response:
+
+Model:
+{
+  '_id': ObjectId - The id of the app
+  'name': String - The name of the app, visible in the portal
+  'type': String - The type of the app
+  'info': String - Additional info describing this app
+  'tags': Array - An array of tags describing this app
+  'owner': ObjectId - The user id of the user who owns the app 
+  'author': ObjectId - The user id of the user who created the app 
+  'locked': Boolean - Is the app locked
+  'access': Integer - The access level you have over this app
+}
+
+
+Example:
+```
+{
+  '_id': {
+    '$oid': '626115b4e69c43478560325e'
+  }, 
+  'name': 'Demo app API', 
+  'type': 'code', 
+  'info': 'Example app', 
+  'tags': ['Programming'], 
+  'owner': {'$oid': '62611595f9d60d94226223'}, 
+  'author': {'$oid': '62611595f9d60d94226223'}, 
+  'locked': False, 
+  'access': 2
+}
+```
\ No newline at end of file