Difference between revisions of "User:Dzonatas Sol/SNOW-375 Resources/Agent"
Jump to navigation
Jump to search
Dzonatas Sol (talk | contribs) |
Dzonatas Sol (talk | contribs) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | |||
{| border="1" cellpadding="5" cellspacing="0" | {| border="1" cellpadding="5" cellspacing="0" | ||
|- | |- | ||
| Line 7: | Line 8: | ||
| rowspan="1" | /Agent/ID | | rowspan="1" | /Agent/ID | ||
| style="text-align:right;" | GET | | style="text-align:right;" | GET | ||
| | | <- { id : uuid } | ||
|- | |- | ||
| rowspan="1" | /Agent/Chat | | rowspan="1" | /Agent/Chat | ||
| style="text-align:right;" | POST | | style="text-align:right;" | POST | ||
| | | -> { text: string, type: integer, channel: integer } <- &status | ||
|- | |- | ||
| rowspan="1" | /Agent/Groups | | rowspan="1" | /Agent/Groups | ||
| style="text-align:right;" | GET | | style="text-align:right;" | GET | ||
| | | <- [ &group, ... ] | ||
|- | |- | ||
| rowspan="1" | /Agent/Position | | rowspan="1" | /Agent/Position | ||
| style="text-align:right;" | GET | | style="text-align:right;" | GET | ||
| | | <- { Position: &position, GlobalPostion: &position, Region: uuid } | ||
|- | |- | ||
| rowspan="2" | /Agent/Typing | | rowspan="2" | /Agent/Typing | ||
| style="text-align:right;" | POST | | style="text-align:right;" | POST | ||
| | | -> &empty <- &status | ||
|- | |- | ||
| style="text-align:right;" | DELETE | | style="text-align:right;" | DELETE | ||
| Stop the typing gesture | | -> &empty <- &status | ||
|} | |||
Note: Description syntax is only based on LLIDL. | |||
== /Agent/ID == | |||
Response is UUID of the logged in Agent/Avatar | |||
== /Agent/Chat == | |||
Deliver a message formatted to Local Chat | |||
== /Agent/Groups == | |||
Response is a list with details of groups joined by the connected agent | |||
== /Agent/Position == | |||
Response is the Region UUID, Position within the region, and global position of the Agent/Avatar | |||
== /Agent/Typing == | |||
=== POST === | |||
Start the typing gesture | |||
=== DELETE === | |||
Stop the typing gesture | |||
== status == | |||
{ status: string } | |||
Value is "ok", consistently | |||
== group == | |||
{ | |||
{| | |||
|- | |||
| id | |||
| : uuid | |||
|- | |||
| insignia | |||
| : uuid | |||
|- | |||
| powers | |||
| : binary | |||
|- | |||
| accept_notices | |||
| : bool | |||
|- | |||
| list_in_profile | |||
| : bool | |||
|- | |||
| contribution | |||
| : integer | |||
|- | |||
| name | |||
| : string | |||
|} | |||
} | |||
== position == | |||
{ | |||
{| | |||
|- | |||
| X | |||
| : real | |||
|- | |||
| Y | |||
| : real | |||
|- | |||
| Z | |||
| : real | |||
|} | |} | ||
} | |||
Revision as of 17:22, 31 July 2010
| Resource | Method | Description |
| /Agent/ID | GET | <- { id : uuid } |
| /Agent/Chat | POST | -> { text: string, type: integer, channel: integer } <- &status |
| /Agent/Groups | GET | <- [ &group, ... ] |
| /Agent/Position | GET | <- { Position: &position, GlobalPostion: &position, Region: uuid } |
| /Agent/Typing | POST | -> &empty <- &status |
| DELETE | -> &empty <- &status |
Note: Description syntax is only based on LLIDL.
/Agent/ID
Response is UUID of the logged in Agent/Avatar
/Agent/Chat
Deliver a message formatted to Local Chat
/Agent/Groups
Response is a list with details of groups joined by the connected agent
/Agent/Position
Response is the Region UUID, Position within the region, and global position of the Agent/Avatar
/Agent/Typing
POST
Start the typing gesture
DELETE
Stop the typing gesture
status
{ status: string }
Value is "ok", consistently
group
{
| id | : uuid |
| insignia | : uuid |
| powers | : binary |
| accept_notices | : bool |
| list_in_profile | : bool |
| contribution | : integer |
| name | : string |
}
position
{
| X | : real |
| Y | : real |
| Z | : real |
}