'collections' are the containers for the webpages you categorise using muddy.

collections can be created, updated and deleted via the API, as well as from the Dashboard interface.

Methods

1. Create collection
2. Update collection
3. View collection
4. Delete collection

Create collection

The create page API is used to create a new collection in the muddy.it system.

To create a collection, a post should be submitted to the URI below. The request should be authenticated with a signed request signature.

http://muddy.it/collections

An xml or json document should be submitted, with an appropriate 'Content-Type' header.

The available response formats are xml and json. To set the response format, the request 'Accept' header needs to be set to application/xml or application/json.

The HTTP request must contain a document that defines the collection attributes. The available attributes are defined in the following table:

Attribute		Permitted Values	Mandatory (y/n)	Default value
label	A label for the collection		n
uri	A URI for the collection		n

Sample Request

View collection.xsd

<?xml version="1.0" encoding="UTF-8"?>
<collection>
  <uri>http://www.somecollection.co.uk</uri>
  <label>Some collection</label>
</collection>
        

Sample Response

A successful response is shown below.

        <response status="OK">
<collection>
  <created-at>2008-12-22T20:51:33Z</created-at>
  <label>Some collection</label>
  <token>e3c73aa4</token>
  <updated-at>2008-12-22T20:51:33Z</updated-at>
  <uri>http://www.somecollection.co.uk</uri>
</collection>
</response>

        
      

Update collection

The udpate collection API is used to update a collection and store it in the muddy.it system.

To update a collection, a post should be submitted to the URI below. The request should be authenticated with a signed request signature.

http://muddy.it/collections/COLLECTION_TOKEN

• COLLECTION_TOKEN = The token for your collection.

An xml or json document should be submitted, with an appropriate 'Content-Type' header.

The available response formats are xml and json. To set the response format, the request 'Accept' header needs to be set to application/xml or application/json.

The HTTP request must contain a document that defines the collection attributes. The available attributes are defined in the following table:

Attribute		Permitted Values	Mandatory (y/n)	Default value
label	An label for the collection		n
label	An label for the collection		n
uri	A URI for the collection		n

View collection

The view collection API is used to update a view a collection's details in the muddy.it system.

To view a collections details, a GET request should be submitted to the URI below. The request should be authenticated with a signed request signature.

http://muddy.it/collections/COLLECTION_TOKEN

• COLLECTION_TOKEN = The TOKEN for your collection.

The available response formats are xml and json. To set the response format, the request 'Accept' header needs to be set to application/xml or application/json.

Sample Responses

A successful response is shown below.

        <response status="OK">
<collection>
  <created-at>2008-12-22T20:51:33Z</created-at>
  <label>Some collection</label>
  <token>e3c73aa4</token>
  <updated-at>2008-12-22T20:51:33Z</updated-at>
  <uri>http://www.somecollection.co.uk</uri>
</collection>
</response>
        
      

Delete collection

The delete collection API is used to delete a collection in the muddy.it system.

To delete a collection, a HTTP DELETE request should be submitted to the URI below. The request should be authenticated with a signed request signature.

http://muddy.it/collections/COLLECTION_TOKEN

• COLLECTION_TOKEN = The TOKEN for your collection.

Sample Responses

A successful response returns a HTTP 200 OK