Home

Welcome to the curates wiki!

REST API

Endpoint: oururl.io/collection

Adding a new collection POST /collection Data: { title: title, url: urlOnOurSite, description: description, user: user, links: [ { url: url, title: title, description: description }, ... ] } Returns _____ if successful or _____ if title or urlOnOurSite are already in use.

Updating a collection POST /collection/:collectionID Data: {links: [ { url: url, title: title, description: description }, ... ] } If the link url is already in the collection, update it with the new title and description. Otherwise, add it link to the collection.

Alternatively: Data: { title: title, ... } Allow for updating other attributes of the collection Returns ____ if successful or _____ if fails

Retrieving a particular collection GET /collection/:collectionID Returns a JSON representation of the collection Data: { title: title, url: urlOnOurSite, description: description, user: user, links: [ { url: url, title: title, description: description }, ... ] }

Retrieve all collection titles, descriptions and url's GET /collection Returns a JSON representation of all the meta data of every collection { collections: [ {}, {}, {} ...] }