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 20:43, 8 October 2008

104 bytes added ,  8 October 2008
no edit summary
No edit summary
Line 83: Line 83:


'''GET''': Retrieve the object.  
'''GET''': Retrieve the object.  
<br>'''PUT''': Add/update the object.
<br>'''POST''': Add/update the object.
<br>'''DELETE''': Delete the object.
<br>'''DELETE''': Delete the object.


Other URLs will allow for structured access. All these support the 'start' and 'limit' parameters to allow for pagination:
Batch processing can be done with:


'''https://''server''/''prefix''/''version''/''user''/''collection'' '''
'''https://''server''/''prefix''/''version''/''user''/''collection'' '''


'''GET''': Returns a list of ids associated with the collection.  
'''GET''': Returns a list of ids associated with the collection.  
<br>'''PUT''': Takes an array of WBOs and adds/updates them within the collection. Identical to looping over a series of /id urls.
<br>'''POST''': Takes an array of WBOs and adds/updates them within the collection. Identical to looping over a series of /id urls.
<br>'''DELETE''': Deletes all objects in this collection.
<br>'''DELETE''': Deletes all objects in this collection.


'''https://''server''/''prefix''/''version''/''user''/''collection''/parent/''id'' '''
Optional parameters:
{| width="100%" cellpadding="3"
|- style="background-color: #efefef;"
| '''Term'''
| '''Description'''  
|- valign="top"
| parentid
| Returns the objects in the collection that are the children of the parent id given.
|- valign="top"
| type
| Returns only objects in the collection that have been annotated with the type 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
|}


'''GET''': Returns a list of ids that are children of the specified id.
<br>'''PUT''': No applicable function.
<br>'''DELETE''': Deletes the object in the collection with this ID and all of its children.
'''https://''server''/''prefix''/''version''/''user''/''collection''/since/''timestamp'' '''
'''GET''': Returns a list of ids modified within the collection since the timestamp given.
<br>'''PUT''': No applicable function.
<br>'''DELETE''': No applicable function.


= Payloads =
= Payloads =
Telliott
canmove, Confirmed users
1,173

edits

Retrieved from "https://wiki.allizom.org/Special:MobileDiff/111777"

Navigation menu