Differences

This shows you the differences between two versions of the page.

--- get_collections [2010/11/04 22:59] – created jay
+++ get_collections [2010/11/08 23:37] (current) – jay
@@ Line 1: / Line 1: @@
 ===== GET /collections.format=====
-  * method: GET /collections.format returns the list of collections owned by you.
+returns the list of collections owned by you.
   * response formats supported: .xml, .json
   * query parameters: none
-  * Curl command line: <code>curl -u jay:apikey http://4thefile.com/api_v1/collections.xml</code>
+  * Curl command line: <code>curl -u user:apikey https://4thefile.com/api_v1/collections.xml</code>
   * example xml response:
 <code xml>
@@ Line 11: / Line 12: @@
   <collection_count>5</collection_count>
   <collections>
-    <collection_api_link>http://4thefile.com/api_v1/collections/ESuVkqZF.xml</collection_api_link>
     <collection_name>4theFile demo</collection_name>
     <collectionkey>ESuVkqZF</collectionkey>
@@ Line 21: / Line 21: @@
     <privacy>1</privacy>
     <resource_count>3</resource_count>
+    <resources_link>https://4thefile.com/api_v1/collections/ESuVkqZF/resources.xml</resources_link>
   </collections>
   <collections>
-    <collection_api_link>http://4thefile.com/api_v1/collections/nV4wRRrx.xml</collection_api_link>
     <collection_name>ApplicationZ demo collection</collection_name>
     <collectionkey>nV4wRRrx</collectionkey>
@@ Line 34: / Line 34: @@
     <privacy>1</privacy>
     <resource_count>2</resource_count>
+    <resources_link>https://4thefile.com/api_v1/collections/nV4wRRrx/resources.xml</resources_link>
   </collections>
-...
+...etc...
 </data>
+</code>
+  * example json response (reformatted for easier viewing)
+<code javascript>
+{"collections":
+	[{"resources_link":"https:\/\/4thefile.com\/api_v1\/collections\/ESuVkqZF\/resources.json",
+	"collectionkey":"ESuVkqZF",
+	"description":"Used to demo how a shareable collection looks in 4theFile",
+	"collection_name":"4theFile demo",
+	"modified":"2010-06-02 14:23:20",
+	"resource_count":3,
+	"created":"2010-06-02 14:01:45",
+	"email":"4thefiledemo",
+	"moderated":9,
+	"privacy":1},
+	{"resources_link":"https:"
+	  // ... etc...
+	,"privacy":1}],
+"collection_count":5}
 </code>
   * field descriptions:
-    * email: the email address for the collection (add @4thefile.com)
+    * email: the email address for collection submissions (@4thefile.com)
-    * moderated: 1=none,3=retro-moderation(collection owner is notified of new submissions),9=closed(no more submissions)
+    * moderated: 1=none,3=retro-moderation(collection owner is notified of new submissions),5=moderated(resource hidden until collection owner approves, not currently supported),9=closed(no more submissions)
     * privacy: 1=shareable, 5=private(anyone can submit but only owner can list collection contents)

4theFile Support Wiki

User Tools

Site Tools

Differences

Page Tools