Sugar Network/API: Difference between revisions

Line 27: Line 27:
* The ''AUTH-TOKEN'' is the {{Code|uid}} which is a hashed value from Sugar profile public SSH key (the same as JID value in Sugar Shell but without the domain part) that does not require any handshake procedures.
* The ''AUTH-TOKEN'' is the {{Code|uid}} which is a hashed value from Sugar profile public SSH key (the same as JID value in Sugar Shell but without the domain part) that does not require any handshake procedures.


== Commons ==
== Objects model ==


=== Properties ===
The following diagram shows the full list of objects implemented by this API.


All resources have the following properties:
{| border="0"
|- valign="top" align="let"
| [[File:Sugar-Network-diagram.png|200px|thumb|Sugar Network objects model]]
|}


* {{Code|guid}}, ''guid''<br>the global unique identifier of the object;
== Commons ==
* {{Code|ctime}}, ''int''<br>the UNIX seconds in UTC timezone of the time when object was created; optional, will be set on a server side otherwise;
* {{Code|mtime}}, ''int''<br>the UNIX seconds in UTC timezone of the time when object was modified; optional, will be set on a server side otherwise;
* {{Code|creator}}, ''guid'', ''read''<br>the ''player'' who created the object.
 
Resources that can be voted (everything except ''player'', ''report'', ''comment'' and ''event''), have these additional properties:
 
* {{Code|respect}}, ''guid'', ''read'', ''create''<br>what ''player'' needs to be respected on getting vote to this object, if empty, the associated ''project'' itself will be voted.
 
And calculated ones:
* {{Code|reputation}}, ''int'', ''read''<br>current object's reputation;
* {{Code|vote}}, ''bool'', ''read'', ''write''<br>did url requester voted for the current object or not.


=== Actions ===
=== Actions ===