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

Prototype Resource

The Prototype Resource is the main resource of the pidoco API. It contains some metadata about a prototype, like the name, the different versions, or when it was last modified. All other resources are relative to one prototype.

List Prototypes

Method:	GET
URI:	/rabbit/api/prototypes.json
Access:	Read

Returns a JSON Array with the prototype ids the user has access to.

CURL Example:

curl -H "Content-Type: application/json" 
   https://pidoco.com/rabbit/api/prototypes.json?api_key=samplekey
> GET /rabbit/api/prototypes.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 14:48:41 GMT
< Last-Modified: Mon, 02 Aug 2010 03:30:02 PDT
< Content-Type: application/json
< Transfer-Encoding: chunked
< 
[42]
			

Show Prototype Metadata

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

Returns a JSON Object with the metadata of the given prototype, e.g. its name.

CURL Example:

curl -v -H "Content-Type: application/json" 
   https://pidoco.com/rabbit/api/prototypes/42.json?api_key=samplekey
> GET /rabbit/api/prototypes/42.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 14:51:01 GMT
< Last-Modified: Mon, 02 Aug 2010 10:30:02 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< 
{ "id":42,
  "versions":{
    "milestones":[
      {"revision":1,"created":"1267817151000",
        "name":"autosaved",
        "user":{"id":0,"name":"System"}}, 
      ... , 
      {"revision":15,"created":"1280620807000",
        "name":"autosaved",
        "user":{"id":0,"name":"System"}}
    ]
  },
  "prototypeData":{
    "lastModification":1280745002000,
    "id":42,
    "lastUser":"volker",
    "name":"Sample Prototype"
  }
}