canmove, Confirmed users
1,173
edits
Services/Sync/Server/Archived/0.3/API: Difference between revisions
Jump to navigation
Jump to search
Services/Sync/Server/Archived/0.3/API (view source)
Revision as of 00:45, 10 November 2008
, 10 November 2008→URL Semantics
| Line 78: | Line 78: | ||
| id | | id | ||
| The Weave Basic Object id. | | The Weave Basic Object id. | ||
|} | |||
Authentication credentials can be checked at: | |||
'''https://''server''/''prefix''/''version''/''user''/ ''' | |||
'''All Protocols''': Returns 1. | |||
A WBO will always be accessible at the following URL. All URLs will have REST semantics: | |||
'''https://''server''/''prefix''/''version''/''user''/''collection''/''id'' ''' | |||
'''GET''': Retrieve the object. | |||
<br>'''PUT''': Add/update the object. | |||
<br>'''DELETE''': Delete the object. | |||
Batch processing can be done with: | |||
'''https://''server''/''prefix''/''version''/''user''/''collection'' ''' | |||
'''GET''': Returns a list of ids associated with the collection. | |||
<br>'''POST''': Takes an array of WBOs and adds/updates them within the collection. Identical to doing a set of PUTs over /id urls. | |||
<br>'''DELETE''': Deletes all objects in this collection. | |||
Optional '''GET''' parameters: | |||
{| width="100%" cellpadding="3" | |||
|- style="background-color: #efefef;" | |||
| '''Term''' | |||
| '''Description''' | |||
|- valign="top" | |||
| wbo | |||
| The json objects/array of json objects to be POSTed | |||
|- valign="top" | |||
| parentid | |||
| Returns the objects in the collection that are the children of the parent id given. | |||
|- valign="top" | |||
| modified | |||
| Returns only objects in the collection that have been modified since the date given, ordered by earliest timestamp. | |||
|- valign="top" | |||
| full | |||
| If defined, returns the full objects, rather than a group of ids. | |||
|- valign="top" | |||
| limit | |||
| Caps the number of objects that will be returned. | |||
|- valign="top" | |||
| offset | |||
| Skips the first n objects, for use with the limit parameter | |||
|} | |} | ||