Support
Page Resource
A prototype consists of several pages. Each page contains elements and might show additional layers. Besides the JSON data type, it can be rendered as XHTML or PNG.
List Pages
| Method: | GET |
| URI: | /rabbit/api/prototypes/{id}/pages.json |
| Access: | Read |
Returns a JSON Array with the ids of all pages of this prototype.
CURL Example:curl -v -H "Content-Type: application/json" https://pidoco.com/rabbit/api/prototypes/42/pages.json?api_key=samplekey > GET /rabbit/api/prototypes/42/pages.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:58:28 GMT < Last-Modified: Mon, 02 Aug 2010 10:30:02 GMT < Content-Type: application/json < Transfer-Encoding: chunked < ["page0001","page4762","page9159"]
Show Page Metadata
| Method: | GET |
| URI: | /rabbit/api/prototypes/{id}/pages/{id}.json |
| Access: | Read |
Returns a JSON Object with the metadata to the page, 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/pages/page0001.json?api_key=samplekey
> GET /rabbit/api/prototypes/42/pages/page0001.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:59:28 GMT
< Last-Modified: Mon, 02 Aug 2010 10:30:02 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
<
{ "id":"page0001",
"layers":["layer2652"],
"name":"Sample Page"
}
Get Page rendered as XHTML
| Method: | GET |
| URI: | /rabbit/api/prototypes/{id}/pages/{id}.html |
| Access: | Read |
Returns the page of the prototype as XHTML just as you can see it in the result view.
Get Page rendered as PNG
| Method: | GET |
| URI: | /rabbit/api/prototypes/{id}/pages/{id}.png |
| Access: | Read |
Returns the page of the prototype rendered as a png raster image.
Newsletter Signup
Sign up for our newsletter to stay up to date.
Don't worry. We only use your email to send you relevant news. No spam. Promise.