• Topics
• FAQs
• API Documentation
  • Sample Applications
  • Prototype Resource
  • Page Resource
  • Layer Resource
  • Discussion Resource
• Professional Services
• User Experience Dictionary
• Important Notice

Discussion Resource

People can add a discussion to a page where they may comment the prototype. Each discussion belongs to a position on a page. It contains entries with an author and timestamp.

List Discussions

Method:	GET
URI:	/rabbit/api/prototypes/{id}/discussions.json
Access:	Read

Returns a JSON Array with the ids of all discussions of this prototype.

CURL Example:

curl -v -H "Content-Type: application/json" 
   https://pidoco.com/rabbit/api/prototypes/42/discussions.json?api_key=samplekey
> GET /rabbit/api/prototypes/42/discussions.json?api_key=samplekey HTTP/1.1
> User-Agent: curl/7.19.6 (i386-apple-darwin10.4.0) libcurl/7.19.6 OpenSSL/0.9.8k zlib/1.2.3
> Host: pidoco.com
> Accept: */*
> Content-Type: application/json
> 
< HTTP/1.1 200 OK
< Date: Mon, 02 Aug 2010 15:16:15 GMT
< Last-Modified: Mon, 02 Aug 2010 08:16:03 PDT
< Content-Type: application/json
< Transfer-Encoding: chunked
< 
[8228,8229]
			

List Discussions for a single page

Method:	GET
URI:	/rabbit/api/prototypes/{id}/pages/{id}/discussions.json
Access:	Read

Returns a JSON Array with the ids of all discussions of this page.

CURL Example:

curl -v -H "Content-Type: application/json" 
   https://pidoco.com/rabbit/api/prototypes/42/pages/page0001/discussions.json?api_key=samplekey
> GET /rabbit/api/prototypes/42/pages/page0001/discussions.json?api_key=samplekey HTTP/1.1
> User-Agent: curl/7.19.6 (i386-apple-darwin10.4.0) libcurl/7.19.6 OpenSSL/0.9.8k zlib/1.2.3
> Host: pidoco.com
> Accept: */*
> Content-Type: application/json
> 
< HTTP/1.1 200 OK
< Date: Mon, 02 Aug 2010 15:17:36 GMT
< Last-Modified: Mon, 02 Aug 2010 15:16:03 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< 
[8228]
			

Show Discussion Metadata

Method:	GET
URI:	/rabbit/api/prototypes/{id}/discussions/{id}.json
Access:	Read

Returns a JSON Object with the metadata to the discussion, e.g. its name and a JSON Array with all layer ids that are visible on this page.

CURL Example:

curl -v -H "Content-Type: application/json" 
   https://pidoco.com/rabbit/api/prototypes/42/discussions/8228.json?api_key=samplekey
> GET /rabbit/api/prototypes/42/discussions/8228.json?api_key=samplekey HTTP/1.1
> User-Agent: curl/7.19.6 (i386-apple-darwin10.4.0) libcurl/7.19.6 OpenSSL/0.9.8k zlib/1.2.3
> Host: pidoco.com
> Accept: */*
> Content-Type: application/json
> 
< HTTP/1.1 200 OK
< Date: Mon, 02 Aug 2010 15:18:51 GMT
< Last-Modified: Mon, 02 Aug 2010 15:15:49 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< 
{ "timestamp":1280762330682,
  "prototypeId":42,
  "id":8228,
  "title":"Sample Title",
  "pageId":"page0001",
  "positionX":434,
  "positionY":129,
  "entries":[
    {"timestamp":1280762144000,
      "author":"volker...pidoco.com",
      "text":"Title set to: Sample Title"},
    {"timestamp":1280762149000,
      "author":"volker...pidoco.com",
      "text":"Sample Entry"}
  ],
  "readAt":0,
  "lastEntryDate":1280762149000
}