Documents

Fields

cid: document project-wide unique identifier number
title: document title string
size: document size (in bytes)
content-type: document content-type
category_id: document category identifier
url: document public access url (for download)
thumbnail_url: document public access thumbnail url (for images only)
status: document status, to mark documents that are still in process of being uploaded to CDN
version: document version, starts at 1
created-at: document creation time
updated-at: document last update time
tags: an array of tags. Only has the name field
ref_tags: an array of tags. Only has the name field
author_id: task author identifier number - only when returning an array of documents
author: See User's Fields - only when returning the specific document
comments: an array of comments. See Comment's Fields - only when returning the specific document

Methods

get_token

returns a token that will be used in the document upload

Parameters

project: PROJECT_ALIAS (alias of a specific project) - mandatory
company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
format: xml | json - not mandatory, defaults to the HTTP Accept header.
callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/documents/get_token

	http://company_alias.goplanapp.com/project_alias/api/documents/get_token?format=json

Output Formats

XML - token


<?xml version="1.0" encoding="UTF-8"?>

<hash>
	<token>f2e5c7ff14b39e4242554a6da77023c434d65daa</token>
</hash>

JSON - token


{"token": "f2e5c7ff14b39e4242554a6da77023c434d65daa"}

get_all

returns last version of all documents in a project (or document's category)

Parameters

category: CATEGORY_ID (identifier of the category) - not mandatory
project: PROJECT_ALIAS (alias of a specific project) - mandatory
company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
format: xml | json - not mandatory, defaults to the HTTP Accept header.
callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/documents/get_all - all documents

	http://company_alias.goplanapp.com/project_alias/api/documents/get_all?category_id=28 - documents from a specific category

	http://company_alias.goplanapp.com/project_alias/api/documents/get_all?format=json&callback;=handlerFunction

	http://company_alias.goplanapp.com/project_alias/api/documents/get_all?category_id=28&format;=json&callback;=handlerFunction

Output Formats

XML - all categories


<?xml version="1.0" encoding="UTF-8"?>
<documents type="array">
	<document>
		<author-id type="integer">1</author-id>
		<category-id type="integer">18</category-id>
		<cid type="integer">6</cid>
		<comments-count type="integer">0</comments-count>
		<company-id type="integer">1</company-id>
		<content-type>image/png</content-type>
		<created-at type="datetime">2009-07-20T16:34:13+01:00</created-at>
		<dimensions>57x57</dimensions>
		<size type="integer">1995</size>
		<status type="integer">1</status>
		<thumbnail-url>
		https://goplan2-dev.s3.amazonaws.com/1/1/896e776ae70b0437276af5290c167358ac7c1899/thumb_HelloWorld.png
		</thumbnail-url>
		<title>HelloWorld</title>
		<updated-at type="datetime">2009-07-20T16:34:26+01:00</updated-at>
		<url>
		https://goplan2-dev.s3.amazonaws.com/1/1/896e776ae70b0437276af5290c167358ac7c1899/HelloWorld.png
		</url>
		<version type="integer">1</version>
		<tags type="array">
			<tag>
				<name>logo</name>
			</tag>
			<tag>
				<name>design</name>
			</tag>
		</tags>
		<ref-tags type="array"/>
	</document>
	<document>
		<author-id type="integer">1</author-id>
		<category-id type="integer">28</category-id>
		<cid type="integer">8</cid>
		<comments-count type="integer">0</comments-count>
		<company-id type="integer">1</company-id>
		<content-type>application/msword</content-type>
		<created-at type="datetime">2009-07-20T16:34:55+01:00</created-at>
		<dimensions nil="true"/>
		<size type="integer">3547</size>
		<status type="integer">1</status>
		<thumbnail-url nil="true"/>
		<title>2009-04-08_Meeting.docx</title>
		<updated-at type="datetime">2009-07-20T16:35:54+01:00</updated-at>
		<url>
		https://goplan2-dev.s3.amazonaws.com/1/1/fa23945344dd755e0e7815910d707418a6b7e76d/2009-04-08_Meeting.docx
		</url>
		<version type="integer">1</version>
		<tags type="array">
			<tag>
				<name>meetings</name>
			</tag>
			<tag>
				<name>reports</name>
			</tag>
			<tag>
				<name>2009</name>
			</tag>
			<tag>
				<name>april</name>
			</tag>
		</tags>
		<ref-tags type="array"/>
	</document>
	<document>
		<author-id type="integer">1</author-id>
		<category-id type="integer">28</category-id>
		<cid type="integer">9</cid>
		<comments-count type="integer">0</comments-count>
		<company-id type="integer">1</company-id>
		<content-type>application/msword</content-type>
		<created-at type="datetime">2009-07-20T16:34:56+01:00</created-at>
		<dimensions nil="true"/>
		<size type="integer">3547</size>
		<status type="integer">1</status>
		<thumbnail-url nil="true"/>
		<title>2009-04-17_Meeting.docx</title>
		<updated-at type="datetime">2009-07-20T16:35:54+01:00</updated-at>
		<url>
		https://goplan2-dev.s3.amazonaws.com/1/1/a2f63ff6e022c3ed323396f5b48deac270e76bc7/2009-04-17_Meeting.docx
		</url>
		<version type="integer">1</version>
		<tags type="array">
			<tag>
				<name>meetings</name>
			</tag>
			<tag>
				<name>reports</name>
			</tag>
			<tag>
				<name>2009</name>
			</tag>
			<tag>
				<name>april</name>
			</tag>
		</tags>
		<ref-tags type="array"/>
	</document>
	<document>
		<author-id type="integer">1</author-id>
		<category-id type="integer">27</category-id>
		<cid type="integer">11</cid>
		<comments-count type="integer">0</comments-count>
		<company-id type="integer">1</company-id>
		<content-type>application/msword</content-type>
		<created-at type="datetime">2009-07-20T16:34:57+01:00</created-at>
		<dimensions nil="true"/>
		<size type="integer">3547</size>
		<status type="integer">1</status>
		<thumbnail-url nil="true"/>
		<title>Personas.docx</title>
		<updated-at type="datetime">2009-07-20T16:35:54+01:00</updated-at>
		<url>
		https://goplan2-dev.s3.amazonaws.com/1/1/c6102b7e211ac105a2f117ae80d507800f5ed870/Personas.docx
		</url>
		<version type="integer">1</version>
		<tags type="array"/>
		<ref-tags type="array"/>
	</document>
	<document>
		<author-id type="integer">1</author-id>
		<category-id type="integer">27</category-id>
		<cid type="integer">12</cid>
		<comments-count type="integer">0</comments-count>
		<company-id type="integer">1</company-id>
		<content-type>application/msword</content-type>
		<created-at type="datetime">2009-07-20T16:34:58+01:00</created-at>
		<dimensions nil="true"/>
		<size type="integer">3547</size>
		<status type="integer">1</status>
		<thumbnail-url nil="true"/>
		<title>User Stories.docx</title>
		<updated-at type="datetime">2009-07-20T16:35:54+01:00</updated-at>
		<url>
		https://goplan2-dev.s3.amazonaws.com/1/1/c2885f26e80337ef05754693c491c1fcfa1cebdf/User_Stories.docx
		</url>
		<version type="integer">1</version>
		<tags type="array">
			<tag>
				<name>stories</name>
			</tag>
		</tags>
		<ref-tags type="array"/>
	</document>
	<document>
		<author-id type="integer">1</author-id>
		<category-id type="integer">1</category-id>
		<cid type="integer">13</cid>
		<comments-count type="integer">0</comments-count>
		<company-id type="integer">1</company-id>
		<content-type>application/pdf</content-type>
		<created-at type="datetime">2009-07-20T16:37:41+01:00</created-at>
		<dimensions nil="true"/>
		<size type="integer">1003418</size>
		<status type="integer">1</status>
		<thumbnail-url nil="true"/>
		<title>REST</title>
		<updated-at type="datetime">2009-07-20T16:37:56+01:00</updated-at>
		<url>
			https://goplan2-dev.s3.amazonaws.com/1/1/a2234ee5e21cb7cfbde92c245efdfb2a5814ea8a/2007_Hansen_etal_2.pdf
		</url>
		<version type="integer">1</version>
	</document>
	<document>
		<author-id type="integer">1</author-id>
		<category-id type="integer">27</category-id>
		<cid type="integer">10</cid>
		<comments-count type="integer">0</comments-count>
		<company-id type="integer">1</company-id>
		<content-type>application/msword</content-type>
		<created-at type="datetime">2009-07-20T16:34:57+01:00</created-at>
		<dimensions nil="true"/>
		<size type="integer">3547</size>
		<status type="integer">1</status>
		<thumbnail-url nil="true"/>
		<title>Backlog.docx</title>
		<updated-at type="datetime">2009-07-20T16:35:54+01:00</updated-at>
		<url>
		https://goplan2-dev.s3.amazonaws.com/1/1/8cd8a31dbcdee0e56a88881350758c1311ebcf21/Backlog.docx
		</url>
		<version type="integer">2</version>
		<tags type="array">
			<tag>
				<name>features</name>
			</tag>
			<tag>
				<name>estimates</name>
			</tag>
		</tags>
		<ref-tags type="array"/>
	</document>
	<document>
		<author-id type="integer">1</author-id>
		<category-id type="integer">28</category-id>
		<cid type="integer">7</cid>
		<comments-count type="integer">0</comments-count>
		<company-id type="integer">1</company-id>
		<content-type>application/msword</content-type>
		<created-at type="datetime">2009-07-20T16:34:55+01:00</created-at>
		<dimensions nil="true"/>
		<size type="integer">3547</size>
		<status type="integer">1</status>
		<thumbnail-url nil="true"/>
		<title>2009-04-01_Meeting.docx</title>
		<updated-at type="datetime">2009-07-20T16:35:54+01:00</updated-at>
		<url>
		https://goplan2-dev.s3.amazonaws.com/1/1/02e19d2da44a10669ff720c3938c5c4d47ae8ac6/2009-04-01_Meeting.docx
		</url>
		<version type="integer">2</version>
		<tags type="array">
			<tag>
				<name>meetings</name>
			</tag>
			<tag>
				<name>reports</name>
			</tag>
			<tag>
				<name>2009</name>
			</tag>
			<tag>
				<name>april</name>
			</tag>
		</tags>
		<ref-tags type="array"/>
	</document>
</documents>

XML - one category


<?xml version="1.0" encoding="UTF-8"?>
<documents type="array">
	<document>
		<author-id type="integer">1</author-id>
		<category-id type="integer">28</category-id>
		<cid type="integer">8</cid>
		<comments-count type="integer">0</comments-count>
		<company-id type="integer">1</company-id>
		<content-type>application/msword</content-type>
		<created-at type="datetime">2009-07-20T16:34:55+01:00</created-at>
		<dimensions nil="true"/>
		<size type="integer">3547</size>
		<status type="integer">1</status>
		<thumbnail-url nil="true"/>
		<title>2009-04-08_Meeting.docx</title>
		<updated-at type="datetime">2009-07-20T16:35:54+01:00</updated-at>
		<url>
		https://goplan2-dev.s3.amazonaws.com/1/1/fa23945344dd755e0e7815910d707418a6b7e76d/2009-04-08_Meeting.docx
		</url>
		<version type="integer">1</version>
		<tags type="array">
			<tag>
				<name>meetings</name>
			</tag>
			<tag>
				<name>reports</name>
			</tag>
			<tag>
				<name>2009</name>
			</tag>
			<tag>
				<name>april</name>
			</tag>
		</tags>
		<ref-tags type="array"/>
	</document>
	<document>
		<author-id type="integer">1</author-id>
		<category-id type="integer">28</category-id>
		<cid type="integer">9</cid>
		<comments-count type="integer">0</comments-count>
		<company-id type="integer">1</company-id>
		<content-type>application/msword</content-type>
		<created-at type="datetime">2009-07-20T16:34:56+01:00</created-at>
		<dimensions nil="true"/>
		<size type="integer">3547</size>
		<status type="integer">1</status>
		<thumbnail-url nil="true"/>
		<title>2009-04-17_Meeting.docx</title>
		<updated-at type="datetime">2009-07-20T16:35:54+01:00</updated-at>
		<url>
		https://goplan2-dev.s3.amazonaws.com/1/1/a2f63ff6e022c3ed323396f5b48deac270e76bc7/2009-04-17_Meeting.docx
		</url>
		<version type="integer">1</version>
		<tags type="array">
			<tag>
				<name>meetings</name>
			</tag>
			<tag>
				<name>reports</name>
			</tag>
			<tag>
				<name>2009</name>
			</tag>
			<tag>
				<name>april</name>
			</tag>
		</tags>
		<ref-tags type="array"/>
	</document>
	<document>
		<author-id type="integer">1</author-id>
		<category-id type="integer">28</category-id>
		<cid type="integer">7</cid>
		<comments-count type="integer">0</comments-count>
		<company-id type="integer">1</company-id>
		<content-type>application/msword</content-type>
		<created-at type="datetime">2009-07-20T16:34:55+01:00</created-at>
		<dimensions nil="true"/>
		<size type="integer">3547</size>
		<status type="integer">1</status>
		<thumbnail-url nil="true"/>
		<title>2009-04-01_Meeting.docx</title>
		<updated-at type="datetime">2009-07-20T16:35:54+01:00</updated-at>
		<url>
		https://goplan2-dev.s3.amazonaws.com/1/1/02e19d2da44a10669ff720c3938c5c4d47ae8ac6/2009-04-01_Meeting.docx
		</url>
		<version type="integer">2</version>
		<tags type="array">
			<tag>
				<name>meetings</name>
			</tag>
			<tag>
				<name>reports</name>
			</tag>
			<tag>
				<name>2009</name>
			</tag>
			<tag>
				<name>april</name>
			</tag>
		</tags>
		<ref-tags type="array"/>
	</document>
</documents>

JSON - all categories


handlerFunction(([{"document": {"tags": [{"name": "logo"}, {"name": "design"}], "status": 1, "content_type": "image/png", "updated_at": "2009/07/20 16:34:26 +0100", "size": 1995, "ref_tags": [], "title": "HelloWorld", "dimensions": "57x57", "url": "https://goplan2-dev.s3.amazonaws.com/1/1/896e776ae70b0437276af5290c167358ac7c1899/HelloWorld.png", "version": 1, "category_id": 18, "company_id": 1, "comments_count": 0, "cid": 6, "author_id": 1, "thumbnail_url": "https://goplan2-dev.s3.amazonaws.com/1/1/896e776ae70b0437276af5290c167358ac7c1899/thumb_HelloWorld.png", "created_at": "2009/07/20 16:34:13 +0100"}}, {"document": {"tags": [{"name": "meetings"}, {"name": "reports"}, {"name": "2009"}, {"name": "april"}], "status": 1, "content_type": "application/msword", "updated_at": "2009/07/20 16:35:54 +0100", "size": 3547, "ref_tags": [], "title": "2009-04-08_Meeting.docx", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/fa23945344dd755e0e7815910d707418a6b7e76d/2009-04-08_Meeting.docx", "version": 1, "category_id": 28, "company_id": 1, "comments_count": 0, "cid": 8, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 16:34:55 +0100"}}, {"document": {"tags": [{"name": "meetings"}, {"name": "reports"}, {"name": "2009"}, {"name": "april"}], "status": 1, "content_type": "application/msword", "updated_at": "2009/07/20 16:35:54 +0100", "size": 3547, "ref_tags": [], "title": "2009-04-17_Meeting.docx", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/a2f63ff6e022c3ed323396f5b48deac270e76bc7/2009-04-17_Meeting.docx", "version": 1, "category_id": 28, "company_id": 1, "comments_count": 0, "cid": 9, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 16:34:56 +0100"}}, {"document": {"tags": [], "status": 1, "content_type": "application/msword", "updated_at": "2009/07/20 16:35:54 +0100", "size": 3547, "ref_tags": [], "title": "Personas.docx", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/c6102b7e211ac105a2f117ae80d507800f5ed870/Personas.docx", "version": 1, "category_id": 27, "company_id": 1, "comments_count": 0, "cid": 11, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 16:34:57 +0100"}}, {"document": {"tags": [{"name": "stories"}], "status": 1, "content_type": "application/msword", "updated_at": "2009/07/20 16:35:54 +0100", "size": 3547, "ref_tags": [], "title": "User Stories.docx", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/c2885f26e80337ef05754693c491c1fcfa1cebdf/User_Stories.docx", "version": 1, "category_id": 27, "company_id": 1, "comments_count": 0, "cid": 12, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 16:34:58 +0100"}}, {"document": {"tags": [], "status": 1, "content_type": "application/pdf", "updated_at": "2009/07/20 16:37:56 +0100", "size": 1003418, "ref_tags": [], "title": "REST", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/a2234ee5e21cb7cfbde92c245efdfb2a5814ea8a/2007_Hansen_etal_2.pdf", "version": 1, "category_id": 1, "company_id": 1, "comments_count": 0, "cid": 13, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 16:37:41 +0100"}}, {"document": {"tags": [{"name": "estimates"}, {"name": "features"}], "status": 1, "content_type": "application/msword", "updated_at": "2009/07/20 16:47:32 +0100", "size": 3547, "ref_tags": [], "title": "Backlog.docx", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/db52c614bea7a390a49624090e2ca23b2ef7fcad/Backlog.docx", "version": 2, "category_id": 27, "company_id": 1, "comments_count": 0, "cid": 10, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 16:47:30 +0100"}}, {"document": {"tags": [{"name": "meetings"}, {"name": "reports"}, {"name": "2009"}, {"name": "april"}], "status": 1, "content_type": "application/msword", "updated_at": "2009/07/20 17:58:59 +0100", "size": 3547, "ref_tags": [], "title": "2009-04-01_Meeting.docx", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/5b9f8e5d8a2904bac44fe9de4f91b1c93769c511/2009-04-01_Meeting.docx", "version": 2, "category_id": 28, "company_id": 1, "comments_count": 0, "cid": 7, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 17:58:57 +0100"}}])

JSON - one category


handlerFunction([{"document": {"tags": [{"name": "meetings"}, {"name": "reports"}, {"name": "2009"}, {"name": "april"}], "status": 1, "content_type": "application/msword", "updated_at": "2009/07/20 16:35:54 +0100", "size": 3547, "ref_tags": [], "title": "2009-04-08_Meeting.docx", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/fa23945344dd755e0e7815910d707418a6b7e76d/2009-04-08_Meeting.docx", "version": 1, "category_id": 28, "company_id": 1, "comments_count": 0, "cid": 8, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 16:34:55 +0100"}}, {"document": {"tags": [{"name": "meetings"}, {"name": "reports"}, {"name": "2009"}, {"name": "april"}], "status": 1, "content_type": "application/msword", "updated_at": "2009/07/20 16:35:54 +0100", "size": 3547, "ref_tags": [], "title": "2009-04-17_Meeting.docx", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/a2f63ff6e022c3ed323396f5b48deac270e76bc7/2009-04-17_Meeting.docx", "version": 1, "category_id": 28, "company_id": 1, "comments_count": 0, "cid": 9, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 16:34:56 +0100"}}, {"document": {"tags": [{"name": "meetings"}, {"name": "reports"}, {"name": "2009"}, {"name": "april"}], "status": 1, "content_type": "application/msword", "updated_at": "2009/07/20 17:58:59 +0100", "size": 3547, "ref_tags": [], "title": "2009-04-01_Meeting.docx", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/5b9f8e5d8a2904bac44fe9de4f91b1c93769c511/2009-04-01_Meeting.docx", "version": 2, "category_id": 28, "company_id": 1, "comments_count": 0, "cid": 7, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 17:58:57 +0100"}}])

get

returns all versions of a document (most recent first)

Parameters

id: ID (project-wide unique document identifier #) - mandatory
project: PROJECT_ALIAS (alias of a specific project) - mandatory
company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
format: xml | json - not mandatory, defaults to the HTTP Accept header.
callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/documents/get?id=7

	http://company_alias.goplanapp.com/project_alias/api/documents/get?id=7?format=json

Output Formats

XML - all categories


<?xml version="1.0" encoding="UTF-8"?>
<documents type="array">
	<document>
		<author-id type="integer">1</author-id>
		<category-id type="integer">28</category-id>
		<cid type="integer">7</cid>
		<comments-count type="integer">0</comments-count>
		<company-id type="integer">1</company-id>
		<content-type>application/msword</content-type>
		<created-at type="datetime">2009-07-20T17:58:57+01:00</created-at>
		<dimensions nil="true"/>
		<size type="integer">3547</size>
		<status type="integer">1</status>
		<thumbnail-url nil="true"/>
		<title>2009-04-01_Meeting.docx</title>
		<updated-at type="datetime">2009-07-20T17:58:59+01:00</updated-at>
		<url>
		https://goplan2-dev.s3.amazonaws.com/1/1/5b9f8e5d8a2904bac44fe9de4f91b1c93769c511/2009-04-01_Meeting.docx
		</url>
		<version type="integer">2</version>
		<tags type="array">
			<tag>
				<name>meetings</name>
			</tag>
			<tag>
				<name>reports</name>
			</tag>
			<tag>
				<name>2009</name>
			</tag>
			<tag>
				<name>april</name>
			</tag>
		</tags>
		<ref-tags type="array"/>
	</document>
	<document>
		<author-id type="integer">1</author-id>
		<category-id type="integer">28</category-id>
		<cid type="integer">7</cid>
		<comments-count type="integer">0</comments-count>
		<company-id type="integer">1</company-id>
		<content-type>application/msword</content-type>
		<created-at type="datetime">2009-07-20T16:34:55+01:00</created-at>
		<dimensions nil="true"/>
		<size type="integer">3547</size>
		<status type="integer">1</status>
		<thumbnail-url nil="true"/>
		<title>2009-04-01_Meeting.docx</title>
		<updated-at type="datetime">2009-07-20T16:35:54+01:00</updated-at>
		<url>
		https://goplan2-dev.s3.amazonaws.com/1/1/02e19d2da44a10669ff720c3938c5c4d47ae8ac6/2009-04-01_Meeting.docx
		</url>
		<version type="integer">1</version>
		<tags type="array">
			<tag>
				<name>meetings</name>
			</tag>
			<tag>
				<name>reports</name>
			</tag>
			<tag>
				<name>2009</name>
			</tag>
			<tag>
				<name>april</name>
			</tag>
		</tags>
		<ref-tags type="array"/>
	</document>
</documents>

JSON


[{"document": {"tags": [{"name": "meetings"}, {"name": "reports"}, {"name": "2009"}, {"name": "april"}], "status": 1, "content_type": "application/msword", "updated_at": "2009/07/20 17:58:59 +0100", "size": 3547, "ref_tags": [], "title": "2009-04-01_Meeting.docx", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/5b9f8e5d8a2904bac44fe9de4f91b1c93769c511/2009-04-01_Meeting.docx", "version": 2, "category_id": 28, "company_id": 1, "comments_count": 0, "cid": 7, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 17:58:57 +0100"}}, {"document": {"tags": [{"name": "meetings"}, {"name": "reports"}, {"name": "2009"}, {"name": "april"}], "status": 1, "content_type": "application/msword", "updated_at": "2009/07/20 16:35:54 +0100", "size": 3547, "ref_tags": [], "title": "2009-04-01_Meeting.docx", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/02e19d2da44a10669ff720c3938c5c4d47ae8ac6/2009-04-01_Meeting.docx", "version": 1, "category_id": 28, "company_id": 1, "comments_count": 0, "cid": 7, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 16:34:55 +0100"}}]

create

creates a new document and returns it

Parameters

file[title]: FILE_TITLE (title of the new document) - mandatory
file[uploaded_data]: FILE_UPLOADED_DATA (file to be uploaded as new document) - mandatory
category: CATEGORY_NAME (name of the category of the new document) - not mandatory
tags[]: TAG_TEXT (use one tags[]=tagtext for each tag on the item. Specify project-wide hot-links with the notation ITEM_TYPE:ITEM_CID i.e.: ticket:3) - not mandatory
project: PROJECT_ALIAS (alias of a specific project) - mandatory
company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
format: xml | json - not mandatory, defaults to the HTTP Accept header.
callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/documents/create - pass the other parameters by POST (multipart)

	http://company_alias.goplanapp.com/project_alias/api/documents/create?format=json - pass the other parameters by POST (multipart)

Output Formats

XML


<?xml version="1.0" encoding="UTF-8"?>
<document>
	<author-id type="integer">1</author-id>
	<category-id type="integer">28</category-id>
	<cid type="integer">7</cid>
	<comments-count type="integer">0</comments-count>
	<company-id type="integer">1</company-id>
	<content-type>application/msword</content-type>
	<created-at type="datetime">2009-07-20T17:58:57+01:00</created-at>
	<dimensions nil="true"/>
	<size type="integer">3547</size>
	<status type="integer">1</status>
	<thumbnail-url nil="true"/>
	<title>2009-04-01_Meeting.docx</title>
	<updated-at type="datetime">2009-07-20T17:58:59+01:00</updated-at>
	<url>
	https://goplan2-dev.s3.amazonaws.com/1/1/5b9f8e5d8a2904bac44fe9de4f91b1c93769c511/2009-04-01_Meeting.docx
	</url>
	<version type="integer">2</version>
	<tags type="array">
		<tag>
			<name>meetings</name>
		</tag>
		<tag>
			<name>reports</name>
		</tag>
		<tag>
			<name>2009</name>
		</tag>
		<tag>
			<name>april</name>
		</tag>
	</tags>
	<ref-tags type="array"/>
</document>

JSON


[{"document": {"tags": [{"name": "meetings"}, {"name": "reports"}, {"name": "2009"}, {"name": "april"}], "status": 1, "content_type": "application/msword", "updated_at": "2009/07/20 16:35:54 +0100", "size": 3547, "ref_tags": [], "title": "2009-04-01_Meeting.docx", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/02e19d2da44a10669ff720c3938c5c4d47ae8ac6/2009-04-01_Meeting.docx", "version": 1, "category_id": 28, "company_id": 1, "comments_count": 0, "cid": 7, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 16:34:55 +0100"}}]

update

updates a document and returns it

Parameters

id: ID (project-wide unique document identifier #) - mandatory
file[title]: FILE_TITLE (title of the new document) - mandatory
category: CATEGORY_NAME (name of the category of the new document) - not mandatory
tags[]: TAG_TEXT (use one tags[]=tagtext for each tag on the item. Specify project-wide hot-links with the notation ITEM_TYPE:ITEM_CID i.e.: ticket:3) - not mandatory
project: PROJECT_ALIAS (alias of a specific project) - mandatory
company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
format: xml | json - not mandatory, defaults to the HTTP Accept header.
callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/documents/create?id=7 - pass the other parameters by POST

	http://company_alias.goplanapp.com/project_alias/api/documents/create?id=7&format;=json - pass the other parameters by POST (multipart)

Output Formats

XML


<?xml version="1.0" encoding="UTF-8"?>
<document>
	<author-id type="integer">1</author-id>
	<category-id type="integer">28</category-id>
	<cid type="integer">7</cid>
	<comments-count type="integer">0</comments-count>
	<company-id type="integer">1</company-id>
	<content-type>application/msword</content-type>
	<created-at type="datetime">2009-07-20T17:58:57+01:00</created-at>
	<dimensions nil="true"/>
	<size type="integer">3547</size>
	<status type="integer">1</status>
	<thumbnail-url nil="true"/>
	<title>2009-04-01_Meeting.docx</title>
	<updated-at type="datetime">2009-07-20T17:58:59+01:00</updated-at>
	<url>
	https://goplan2-dev.s3.amazonaws.com/1/1/5b9f8e5d8a2904bac44fe9de4f91b1c93769c511/2009-04-01_Meeting.docx
	</url>
	<version type="integer">2</version>
	<tags type="array">
		<tag>
			<name>meetings</name>
		</tag>
		<tag>
			<name>reports</name>
		</tag>
		<tag>
			<name>2009</name>
		</tag>
		<tag>
			<name>april</name>
		</tag>
	</tags>
	<ref-tags type="array"/>
</document>

JSON


[{"document": {"tags": [{"name": "meetings"}, {"name": "reports"}, {"name": "2009"}, {"name": "april"}], "status": 1, "content_type": "application/msword", "updated_at": "2009/07/20 16:35:54 +0100", "size": 3547, "ref_tags": [], "title": "2009-04-01_Meeting.docx", "dimensions": null, "url": "https://goplan2-dev.s3.amazonaws.com/1/1/02e19d2da44a10669ff720c3938c5c4d47ae8ac6/2009-04-01_Meeting.docx", "version": 1, "category_id": 28, "company_id": 1, "comments_count": 0, "cid": 7, "author_id": 1, "thumbnail_url": null, "created_at": "2009/07/20 16:34:55 +0100"}}]

destroy

updates a document and returns it

Parameters

id: ID (project-wide unique document identifier #) - mandatory
project: PROJECT_ALIAS (alias of a specific project) - mandatory
company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
format: xml | json - not mandatory, defaults to the HTTP Accept header.
callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/documents/destroy?id=7 - pass the other parameters by POST

	http://company_alias.goplanapp.com/project_alias/api/documents/destroy?id=7&format;=json - pass the other parameters by POST (multipart)

Document Categories

Fields

id: document category unique identifier number
name: document category name
created_at: document category creation time
updated_at: document category last update time

Methods

get_all

returns all document categories of the project

Parameters

project: PROJECT_ALIAS (alias of a specific project) - mandatory
company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
format: xml | json - not mandatory, defaults to the HTTP Accept header.
callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/document_categories/get_all

	http://company_alias.goplanapp.com/project_alias/api/document_categories/get_all?format=json

Output Formats

XML


<?xml version="1.0" encoding="UTF-8"?>
<file-categories type="array">
	<file-category>
		<company-id type="integer">1</company-id>
		<created-at type="datetime">2009-05-23T00:56:53+01:00</created-at>
		<id type="integer">18</id>
		<name>Design</name>
		<project-id type="integer">1</project-id>
		<updated-at type="datetime">2009-07-20T14:24:41+01:00</updated-at>
	</file-category>
	<file-category>
		<company-id type="integer">1</company-id>
		<created-at type="datetime">2009-07-20T14:25:42+01:00</created-at>
		<id type="integer">27</id>
		<name>Development</name>
		<project-id type="integer">1</project-id>
		<updated-at type="datetime">2009-07-20T14:25:42+01:00</updated-at>
	</file-category>
	<file-category>
		<company-id type="integer">1</company-id>
		<created-at type="datetime">2009-07-20T14:25:58+01:00</created-at>
		<id type="integer">28</id>
		<name>Meeting Reports</name>
		<project-id type="integer">1</project-id>
		<updated-at type="datetime">2009-07-20T14:25:58+01:00</updated-at>
	</file-category>
	<file-category>
		<company-id type="integer">1</company-id>
		<created-at type="datetime">2009-05-04T15:36:45+01:00</created-at>
		<id type="integer">1</id>
		<name>Uncategorized</name>
		<project-id type="integer">1</project-id>
		<updated-at type="datetime">2009-05-04T15:36:45+01:00</updated-at>
	</file-category>
</file-categories>

JSON


[{"file_category": {"name": "Design", "updated_at": "2009/07/20 14:24:41 +0100", "project_id": 1, "id": 18, "company_id": 1, "created_at": "2009/05/23 00:56:53 +0100"}}, {"file_category": {"name": "Development", "updated_at": "2009/07/20 14:25:42 +0100", "project_id": 1, "id": 27, "company_id": 1, "created_at": "2009/07/20 14:25:42 +0100"}}, {"file_category": {"name": "Meeting Reports", "updated_at": "2009/07/20 14:25:58 +0100", "project_id": 1, "id": 28, "company_id": 1, "created_at": "2009/07/20 14:25:58 +0100"}}, {"file_category": {"name": "Uncategorized", "updated_at": "2009/05/04 15:36:45 +0100", "project_id": 1, "id": 1, "company_id": 1, "created_at": "2009/05/04 15:36:45 +0100"}}]

create

creates a new document category and returns it

Parameters

category[name]: CATEGORY_NAME (name of the new document category) - mandatory
project: PROJECT_ALIAS (alias of a specific project) - mandatory
company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
format: xml | json - not mandatory, defaults to the HTTP Accept header.
callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/document_categories/create - pass the other parameters by POST

	http://company_alias.goplanapp.com/project_alias/api/document_categories/create?format=json&category;[name]=design

Output Formats

XML


<?xml version="1.0" encoding="UTF-8"?>
<file-category>
	<company-id type="integer">1</company-id>
	<created-at type="datetime">2009-05-23T00:56:53+01:00</created-at>
	<id type="integer">18</id>
	<name>Design</name>
	<project-id type="integer">1</project-id>
	<updated-at type="datetime">2009-07-20T14:24:41+01:00</updated-at>
</file-category>

JSON


[{"file_category": {"name": "Design", "updated_at": "2009/07/20 14:24:41 +0100", "project_id": 1, "id": 18, "company_id": 1, "created_at": "2009/05/23 00:56:53 +0100"}}]

update

updates a document category and returns it

Parameters

id: CATEGORY_ID (identifier of the document category) - mandatory
category[name]: CATEGORY_NAME (name of the new document category) - mandatory
project: PROJECT_ALIAS (alias of a specific project) - mandatory
company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
format: xml | json - not mandatory, defaults to the HTTP Accept header.
callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/document_categories/update?id=18&category;[name]=drawings 

	http://company_alias.goplanapp.com/project_alias/api/document_categories/create?id=18&category;[name]=drawings&format;=json

Output Formats

XML


<?xml version="1.0" encoding="UTF-8"?>
<file-category>
	<company-id type="integer">1</company-id>
	<created-at type="datetime">2009-05-23T00:56:53+01:00</created-at>
	<id type="integer">18</id>
	<name>Drawings</name>
	<project-id type="integer">1</project-id>
	<updated-at type="datetime">2009-07-21T14:24:41+01:00</updated-at>
</file-category>

JSON


[{"file_category": {"name": "Drawings", "updated_at": "2009/07/21 14:24:41 +0100", "project_id": 1, "id": 18, "company_id": 1, "created_at": "2009/05/23 00:56:53 +0100"}}]

destroy

deletes a file category

Parameters

id: ID (identifier of the document category) - mandatory
project: PROJECT_ALIAS (alias of a specific project) - mandatory
company: COMPANY_ALIAS (passed in as a subdomain) - mandatory
format: xml | json - not mandatory, defaults to the HTTP Accept header.
callback: JAVASCRIPT_FUNCTION (a javascript function identifier) - not mandatory, only used on json

Endpoint examples


	http://company_alias.goplanapp.com/project_alias/api/document_categories/destroy?id=18 

	http://company_alias.goplanapp.com/project_alias/api/document_categories/destroy?id=18&format;=json

Goplan is a product of Reinhardt Media, Ltd. | Contact support | Terms of Service

Developer account:

API reference:

Documents

Fields

Methods

get_token

Parameters

Endpoint examples

Output Formats

get_all

Parameters

Endpoint examples

Output Formats

get

Parameters

Endpoint examples

Output Formats

create

Parameters

Endpoint examples

Output Formats

update

Parameters

Endpoint examples

Output Formats

destroy

Parameters

Endpoint examples

Document Categories

Fields

Methods

get_all

Parameters

Endpoint examples

Output Formats

create

Parameters

Endpoint examples

Output Formats

update

Parameters

Endpoint examples

Output Formats

destroy

Parameters

Endpoint examples