|
|
|
## Actions
|
|
|
|
|
|
|
|
### Info
|
|
|
|
Get the document of a particular robot.
|
|
|
|
```
|
| ... | ... | @@ -5,7 +7,7 @@ https://portal.robotsindeklas.nl/API/v1/robot/info |
|
|
|
```
|
|
|
|
|
|
|
|
Parameter:
|
|
|
|
- **robot**, *string*: the object id of the robot you want the info of.
|
|
|
|
- **robot** - *string*: the object id of the robot you want the info of.
|
|
|
|
|
|
|
|
|
|
|
|
### Lock
|
| ... | ... | @@ -15,8 +17,8 @@ https://portal.robotsindeklas.nl/API/v1/robot/lock |
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
- **robot**, *string*: the object id of the robot you want to lock;
|
|
|
|
- **lock**, *boolean*, (optional, default: false): lock (true) or unlock (false) this robot.
|
|
|
|
- **robot** - *string*: the object id of the robot you want to lock;
|
|
|
|
- **lock** - *boolean* - (optional, default: false): lock (true) or unlock (false) this robot.
|
|
|
|
|
|
|
|
|
|
|
|
### Share
|
| ... | ... | @@ -32,6 +34,45 @@ https://portal.robotsindeklas.nl/API/v1/robot/share |
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
- **robot**, *string*: the object id of the robot 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 robot with. |
|
|
\ No newline at end of file |
|
|
|
- **robot** - *string*: the object id of the robot 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 robot with.
|
|
|
|
|
|
|
|
|
|
|
|
## Response
|
|
|
|
|
|
|
|
If the request was successful, you will receive the following response:
|
|
|
|
|
|
|
|
```
|
|
|
|
{
|
|
|
|
'_id': ObjectId - The id of the robot
|
|
|
|
'data': {
|
|
|
|
'status': String - the current status of the robot (online, offline, connecting)
|
|
|
|
},
|
|
|
|
'name': String - The name of the robot
|
|
|
|
'type': String - The type of the robot (nao, alpha-mini etc.)
|
|
|
|
'tags': Array - An array of tags describing this robot (currently not used)
|
|
|
|
'owner': ObjectId - The user id of the user who owns the robot
|
|
|
|
'access': Integer - The access level you have over this robot
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
```
|
|
|
|
{
|
|
|
|
'_id': {
|
|
|
|
'$oid': '601ca6e8326d7fe5d124b108'
|
|
|
|
},
|
|
|
|
'data': {
|
|
|
|
'status': 'online'
|
|
|
|
},
|
|
|
|
'name': 'Robbie',
|
|
|
|
'type': 'nao',
|
|
|
|
'tags': [],
|
|
|
|
'owner': {
|
|
|
|
'$oid': '602de20c9d6cfb1226c27b2b'
|
|
|
|
},
|
|
|
|
'access': 3
|
|
|
|
}
|
|
|
|
``` |
|
|
\ No newline at end of file |
