wedoistapi documentation › pdf › wedoistapi › latest › wedoistapi.pdf"id":43670} 1.1.3update...

WedoistAPI DocumentationRelease Alpha 1

Chris Statzer

June 09, 2012

CONTENTS

i

WedoistAPI Documentation, Release Alpha 1

The following outlines Wedoist’s API that can be used by end-users to develop or extend their application with theservices of Wedoist.com. This refrence outlines the various requests to authentcate and use the functionality of theservice, examples of those requests, and outlines of the data returned.

Currently the exposed API is accessed through HTTP GET/POST and returns properly formatted JSON output thatcan be decoded by your language or library of choice.

CONTENTS 1


2 CONTENTS

CHAPTER

ONE

CONTENTS:

1.1 Users

1.1.1 getTimezones

Description: Returns a list of the timezones that the API allows.

Response Format: JSON

HTTP Method: GET

Parameters:

none None

Example Value: “None”

Example Request:

http://wedoist.com/API/Users/getTimezones

[ [’-1100’, ’Pacific/Midway’, ’(GMT-1100) International Date Line West’],[’-1100’, ’Pacific/Midway’, ’(GMT-1100) Midway Island’] ]

1.1.2 register

Description: Register a new user on wedoist.


HTTP Method: POST

Parameters:

email A valid email address for the new user.

Example Value: “[email protected]“

full_name The new user’s full name.

Example Value: “John Wedoist”

password The new user’s password. It must contain 5 characters or more to be valid.

Example Value: “strong_password”

3

mailto:[email protected]


timezone The new user’s timezone.

Example Value: “Pacific/Midway”

Example Request:

http://wedoist.com/API/Users/[email protected]&full_name=John Wedoist&password=strong_password&timezone=Pacific/Midway

{"date_format": 0,"default_project": 42,"has_to_setup": 0,"partition": 1,"number_of_projects": 1,"email": "[email protected]","time_format": 0,"join_date": "Fri, 25 May 2012 01:06:59","avatar": null,"full_name": "John Wedoist","timezone": "US\/Arizona","id": 43670}

1.1.3 update

Description: Update the logged in users account information.


HTTP Method: POST

Parameters:

current_password The current password of the user trying to update their information.


email (optional) The user’s new email address to change to.


full_name (optional) The user’s new name.


password (optional) The user’s new password. The password must be over 5 character to be valid.


timezone (optional) The user’s new timezone.

Example Value: “Pacific/Midway”

Example Request:

http://wedoist.com/API/?current_password=strong_password&[email protected]&full_name=John Wedoist&password=strong_password&timezone=Pacific/Midway

{"status": "ok"}

1.1.4 uploadPhoto

Description: Upload a photo for the user avatar with HTTP Post

4 Chapter 1. Contents:




HTTP Method: POST

Parameters:

image The image data to upload.

Example Value: “”

Example Request:

http://wedoist.com/API/Users/uploadPhoto?image=

{"status": "ok"}

1.1.5 getUser

Description: Get a single user from a project.


HTTP Method: GET

Parameters:

project_id The id of the project to get the user from

Example Value: “42”

user_id The id of the user to fetch.


Example Request:

http://wedoist.com/API/Users/getUser?project_id=42&user_id=23


1.1.6 logout

Description: Log the user out of the service.


HTTP Method: POST

Parameters:

1.1. Users 5


none None

Example Value: “None”

Example Request:

http://wedoist.com/API/Users/logout

{"status": "ok"}

1.1.7 login

Description: Logs the user into Wedoist and returns the users details.


HTTP Method: POST

Parameters:

email A valid email for the registered user.


Example Request:

http://wedoist.com/API/Users/[email protected]

{"date_format": 0,"default_project": 42,"has_to_setup": 0,"partition": 1,"number_of_projects": 1,"email": "[email protected]","time_format": 0,"join_date": "Sun, 13 May 2012 20:20:53","avatar": "254bd140e8520bb8e25b5d2da98244b2","full_name": "John Cardholder","timezone": "America\/Chicago","id": 23}

1.2 Lists

Lists are collections of items that comprice a multipart task. The lists API allows you to view, build and delete lists ofitems.

1.2.1 unarchive

Description: Unarchive an archived list.


HTTP Method: POST

Parameters:




id The id of the list to unarchive.


Example Request:

http://wedoist.com/API/?id=23

{ "archived": false,"project_id": 42,"order": 504,"name": "Foo Man Choo","id": 23}

1.2.2 move

Description: Move a list to another project.


HTTP Method: POST

Parameters:

id The id of the list to move.


project_id The id of the project to move the list to.


Example Request:

http://wedoist.com/API/?id=23&project_id=43

{ "archived": false,"project_id": 43,"order": 504,"name": "Foo Man Choo","id": 23}

1.2.3 get

Description: Returns the details of a single list item by its id.


HTTP Method: GET

Parameters:

id The id of the project.


Example Request:

http://wedoist.com/API/Lists/get?id=23

1.2. Lists 7


{"archived": false,"name": "Inbox","id": 23,"is_inbox": true,"project_id": 42,"order": 0

}

1.2.4 getAll

Description: Returns the details of all ofthe lists associated with a project.


HTTP Method: GET

Parameters:

project_id The id of the tasklist.


Example Request:

http://wedoist.com/API/Lists/getAll?project_id=23

[{"archived": false,"name": "Inbox","id": 23,"is_inbox": true,"project_id": 42,"order": 0},

{"archived": false,"name": "Important List","id": 24,"is_inbox": true,"project_id": 42,"order": 0}, ]

1.2.5 updateOrders

Description: Updates how the lists are ordered.


HTTP Method: POST

Parameters:

orders A JSON list of the list’s order.

Example Value: “[3,4,1,2]”

Example Request:



http://wedoist.com/API/Lists/updateOrders?orders=[3,4,1,2]

{"status": "ok"}

1.2.6 update

Description: Change the name or order of a list.


HTTP Method: GET

Parameters:

id The id of the list.


name (optional) The new name for the list.

Example Value: “Foo Man Choo”

order (optional) The order of the list.


Example Request:

http://wedoist.com/API/Lists/update?id=23&name=Foo Man Choo&order=3

{"archived": false,"project_id": 44146,"order": 503,"name": "Foo Man Choo","id": 93340

}

1.2.7 archive

Description: Archive a list.


HTTP Method: POST

Parameters:

id The id of the list to archive.


Example Request:

http://wedoist.com/API/Lists/archive?id=23

{ "archived": true,"name": "Foo Man Choo","id": 23,"archived_date": "Fri, 25 May 2012 19:28:24","project_id": 42,

1.2. Lists 9


"order": 503}

1.2.8 add

Description:


HTTP Method: POST

Parameters:

project_id The project to add the list to.


name The name of the list.

Example Value: “Foo List”

order The order to place this list in the list of lists.


Example Request:

http://wedoist.com/API/Lists/add?project_id=42&name=Foo List&order=2

{"archived": false,"project_id": 42,"order": 3,"name": "Foo List","id": 23}

1.2.9 getArchived

Description: Get a list of the archived lists in a project.


HTTP Method: GET

Parameters:

project_id The id of the project to fetch the archived lists from.


offset The first item in the list of archived lists.


limit Limit the number of results to return.


Example Request:

http://wedoist.com/API/Lists/getArchived?project_id=42&offset=10&limit=20



[{"archived": true,"project_id": 44146,"order": 503,"name": "Foo Man Choo","id": 93340

},]

1.2.10 delete

Description: Delete a task list


HTTP Method: POST

Parameters:

id The id of the tasklist


Example Request:

http://wedoist.com/API/Lists/delete?id=23

{"archived": false,"project_id": 42,"order": 3,"name": "Foo List","id": 23}

1.3 Chat

The chat API allows an application to tell Wedoist that you are online and to retrieve and post messages in the projectchat just as if you were online. All the chat calls are project specific and require a valid project_id.

1.3.1 isPermanentOffline

Description: Is the user marked permanently offline?


HTTP Method: POST

Parameters:

project_id The id of the target project to make the user as offonline.


Example Request:

http://wedoist.com/API/Chat/isPermanentOffline?project_id=42

{"result": false}

1.3. Chat 11


1.3.2 addMessage

Description:


HTTP Method: POST

Parameters:

project_id The id of the target project to add the chat message to.


Example Request:

http://wedoist.com/API/Chat/addMessage?project_id=42

{"status": "ok"}

1.3.3 markPermanentOffline

Description: Mark the user as permanently offline in the specified project


HTTP Method: POST

Parameters:

project_id The project id of


Example Request:

http://wedoist.com/API/Chat/markPermanentOffline?project_id=42

{"status": "ok"}

1.3.4 getLatestMessages

Description:


HTTP Method: POST

Parameters:

project_id The id of the target project to get the latest messages from.


Example Request:

http://wedoist.com/API/Chat/getLatestMessages?project_id=42

[{"timestamp": 1338140975.35,"message": "This is a message.","posted": "Sun, 27 May 2012 17:49:35","id": "7e9c6d5925f9ac356018c2f0e8eabc3d",



"from_uid": 54},]

1.3.5 markOnlineBroadcast

Description:


HTTP Method: POST

Parameters:

project_id The id of the target project to make the user as online.


Example Request:

http://wedoist.com/API/Chat/markOnlineBroadcast?project_id=42

[54]

1.3.6 markOnlinePoll

Description: Poll the server updating your online status and return a list of online users.


HTTP Method: POST

Parameters:

project_id The project id of target project.


Example Request:

http://wedoist.com/API/Chat/markOnlinePoll?project_id=42

[54]

1.4 Projects

The projects API allows you to create and delete projects as well as change administrative options.

1.4.1 unarchive

Description: Unarchive a project.


HTTP Method: POST

Parameters:

1.4. Projects 13


project_id The id of the project to ubarchive.


Example Request:

http://wedoist.com/API/Projects/unarchive?project_id=42

{"status": "ok"}

1.4.2 getUsers

Description:


HTTP Method: GET

Parameters:

project_id The id of the project to get the users from.


without_logged_in Exclude the users that are logged in.

Example Value: “false”

Example Request:

http://wedoist.com/API/Projects/getUsers?project_id=42&without_logged_in=false

[{"date_format": 0,"default_project": 42,"has_to_setup": 0,"partition": 1,"number_of_projects": 1,"email": "[email protected]","time_format": 0,"join_date": "Fri, 25 May 2012 01:06:59","avatar": null,"full_name": "John Wedoist","timezone": "US\/Arizona","id": 43670}, ]

1.4.3 get

Description: Get a project by it’s id.


HTTP Method: GET

Parameters:

project_id The id of the project to fetch.


Example Request:



http://wedoist.com/API/Projects/get?project_id=42

{ "archived": false,"from_plan_unlimited": false,"general_collection": 82,"plan": "free","logo": null,"privilege": "holder","inbox_list": 462,"holder_uid": 314,"id": 42,"name": "Foo Project"}

1.4.4 updateUserPrivilege

Description:


HTTP Method: POST

Parameters:

project_id The id of the project to change the user’s privilege in.


user_id The id of the user to change the privilege on.


privilege The intended privilege to assign to the user. Can be “user” or “holder”

Example Value: “user”

Example Request:

http://wedoist.com/API/Projects/updateUserPrivilege?project_id=32&user_id=462&privilege=user

{"status": "ok"}

1.4.5 updateLastLogin

Description: Update the last time the user logged in to a particular project.


HTTP Method: POST

Parameters:

project_id The id of the project to update the last logged in time on.


Example Request:

http://wedoist.com/API/?project_id=34

{"status": "ok"}

1.4. Projects 15


1.4.6 getAll

Description: Returns all of the users projects. Optionally can filter for only active projects.


HTTP Method: GET

Parameters:

only_active (optional) Return only the active projects.


Example Request:

http://wedoist.com/API/Projects/getAll?only_active=false


1.4.7 add

Description: Create a new project.


HTTP Method: POST

Parameters:

name The name of the new project.

Example Value: “Foo Project Redux”

Example Request:

http://wedoist.com/API/Projects/add?name=Foo Project Redux




1.4.8 removeUser

Description: Remove a user from a project.


HTTP Method: POST

Parameters:

project_id The id of the project to remove the user from.


user_id The id of the user to remove.


Example Request:

http://wedoist.com/API/Projects/removeUser?project_id=42&user_id=462

{"status": "ok"}

1.4.9 deleteProjectLogo

Description: Delete the logo from a project.


HTTP Method: POST

Parameters:

project_id The id of the project to delete the logo from.


Example Request:

http://wedoist.com/API/?project_id=42

{"status": "ok"}

1.4.10 getWithData

Description: Get a list of project with it’s data.


HTTP Method: GET

Parameters:

project_id The id of the project to fetch.


update_last_login (optional) Update the last login?


1.4. Projects 17


only_active (optional) Return only active projects.


Example Request:

http://wedoist.com/API/getWithData?project_id=42&update_last_login=false&only_active=false

[{ "archived": false,"from_plan_unlimited": false,"general_collection": 82,"plan": "free","logo": null,"privilege": "holder","inbox_list": 462,"holder_uid": 314,"id": 42,"name": "Foo Project"}, ]

1.4.11 archive

Description: Archive a project.


HTTP Method: POST

Parameters:

project_id The id of the project to archive.


Example Request:

http://wedoist.com/API/Projects/archive?project_id=42

{"status": "ok"}

1.4.12 uploadProjectLogo

Description: Upload a project logo with an HTTP POST request.


HTTP Method: POST

Parameters:

project_id The id of the project to upload the logo too.


image The image data.


Example Request:

http://wedoist.com/API/Projects/uploadProjectLogo?project_id=42&image=



{"status": "ok"}

1.4.13 delete

Description: Delete a project.


HTTP Method: POST

Parameters:

project_id The id of the project to delete.


current_password (optional) The user’s current password.


Example Request:

http://wedoist.com/API/Projects/delete?project_id=42&current_password=strong_password


1.5 Invitations

The invitations API allows you to send and accept invitations to Wedoist.com.

1.5.1 getInviteSuggestions

Description:


HTTP Method: POST

Parameters:

project_id The id of the project to to get invite suggestions from.


Example Request:

http://wedoist.com/API/Invitations/getInviteSuggestions?project_id=42

1.5. Invitations 19


1.5.2 redeemInvite

Description:


HTTP Method: POST

Parameters:

password The password.


invite The the invite code that was sent to the user though email.


Example Request:

http://wedoist.com/API/Invitations/getInviteSuggestions?password=strong_password&invite=strong_password


1.5.3 addUser

Description: Add either an existing user or invite a new user to join the project by email.


HTTP Method: POST

Parameters:

project_id The id of the project to add the user too.


email A valid email address of a current Wedoist user or to invite someone by email.


full_name (optional) The name of the user to invite for email invitation.


personal_note A snippet of text to include in the email invitation.

Example Value: “We need you on this John.”




Example Request:

http://wedoist.com/API/Invitations/addUser?project_id=42&[email protected]&full_name=John Wedoist&personal_note=We need you on this John.

{’status’: ’ADDED USER TO PROJECT.}

1.6 Dashboard

The API calls used by the wedoist web interface.

1.6.1 getAllPeople

Description: Return all of the users in all of the projects.


HTTP Method: GET

Parameters:

None


Example Request:

http://wedoist.com/API/Dashboard/getAllPeople?None=

{ "23": { "default_project": 44146,"has_to_setup": false,"id": 23,"number_of_projects": 2,"join_date": "Sun, 13 May 2012 20:20:53","avatar": "254bd140e8520bb8e25b5d2da98244b2","full_name": "John Wedoist","promo.guided_tour": true,"timezone": "America\/Chicago","email": "[email protected]"}

}

1.6.2 getAllProjectUpdates

Description: Get all updates from all projects.


HTTP Method: GET

Parameters:

type_id(optional) The type of updates to fetch. Can be of type status, chat_log, item, or document

Example Value: “item”

poster_uid (optional) Filter by user_id.


1.6. Dashboard 21


limit (optional) Limit the number of results returned by the query.


only_active (optional) Filter by active projects only.


Example Request:

http://wedoist.com/API/Dashboard/getAllProjectUpdates?type_id(optional)=item&poster_uid=23&limit=3&only_active=false

{ "logged_in_user": { "default_project": 42,"stats": { "status_updates": 2,

"completed_tasks": 0,"comments": 2 }

"has_to_setup": false,"email": "[email protected]","number_of_projects": 2,"join_date": "Sun, 13 May 2012 20:20:53","last_login": "Mon, 28 May 2012 13:29:42","avatar": "254bd140e8520bb8e25b5d2da98244b2","full_name": "Frank Wedoist","promo.guided_tour": true,"privilege": "holder","timezone": "America\/Chicago","id": 42745},

"users": { "42745": { "default_project": 42,"stats": { "status_updates": 2,

"completed_tasks": 0,"comments": 2},

"has_to_setup": false,"email": "[email protected]","number_of_projects": 2,"join_date": "Sun, 13 May 2012 20:20:53","last_login": "Mon, 28 May 2012 13:29:42","avatar": "254bd140e8520bb8e25b5d2da98244b2","full_name": "Frank Wedoist","promo.guided_tour": true,"privilege": "holder","timezone": "America\/Chicago","id": 256 }

},"project_data": [ {"project": { "archived": false,

"from_plan_unlimited": false,"general_collection": 45935,"plan": "free","logo": null,"privilege": "holder","inbox_list": 91435,"holder_uid": 42,"id": 44146,"name": "Foo Project"},

"statuses":[{"posted": "Sun, 27 May 2012 19:35:23","type_id": 5,"comment_seen": 0,"poster_uid": 42,"content": "Simple status update.","comment_count": 1},]

},



]}

1.6.3 getAllUnreadStats

Description: Return the unread stats from all the projects.


HTTP Method: GET

Parameters:

only_active (optional) Filter by active projects only.


Example Request:

http://wedoist.com/API/Dashboard/getAllUnreadStats?only_active=false

[{"stats": [{"status_updates": 1,"project_id": 42,"completed_tasks": 0,"comments": 0},

{"status_updates": 2,"project_id": 44146,"completed_tasks": 0,"comments": 2}],

"user": {"default_project": 42,"has_to_setup": false,"email": "[email protected]","number_of_projects": 2,"join_date": "Sun, 13 May 2012 20:20:53","avatar": "254bd140e8520bb8e25b5d2da98244b2","full_name": "Frank Wedoist","promo.guided_tour": true,"timezone": "America\/Chicago","id": 42745}

},]

1.6.4 getAllUserStats

Description: Return the user stats from all of the projects.


HTTP Method: GET

Parameters:

None


Example Request:

http://wedoist.com/API/Dashboard/getAllUserStats?None=

1.6. Dashboard 23


{ "stats": [{"status_updates": 1,"project_id": 42,"completed_tasks": 0,"comments": 0},

{"status_updates": 2,"project_id": 44146,"completed_tasks": 0,"comments": 2}],

"user": {"default_project": 42,"has_to_setup": false,"email": "[email protected]","number_of_projects": 2,"join_date": "Sun, 13 May 2012 20:20:53","avatar": "254bd140e8520bb8e25b5d2da98244b2","full_name": "Frank Wedoist","promo.guided_tour": true,"timezone": "America\/Chicago","id": 42745}

}

1.6.5 getAllTasks

Description: Get all tasks from all projects.


HTTP Method: GET

Parameters:

date (optional) Filter the returned tasks by date.

Example Value: “2012-3-24”

user_id (optional) Filter the returned tasks by user_id


as_count (optional) Return only counts of the tasks.


only_active (optional) Filter by active tasks only.

Example Value: “true”

Example Request:

http://wedoist.com/API/Dashboard/getAllTasks?date=2012-3-24&user_id=23&as_count=false&only_active=true

[{ "project": { "archived": false,"from_plan_unlimited": false,"general_collection": 46988,"plan": "free","logo": null,"privilege": "holder","inbox_list": 93315,"holder_uid": 42745,"id": 45120,"name": "another one"},

"users": [{"default_project": 42,



"has_to_setup": false,"email": "[email protected]","number_of_projects": 2,"join_date": "Sun, 13 May 2012 20:20:53","avatar": "254bd140e8520bb8e25b5d2da98244b2","full_name": "Frank Wedoist","promo.guided_tour": true,"timezone": "America\/Chicago","id": 42745},],

},]

1.7 Items

Items represent individual tasks in task lists. The items API allows you to manipulate individual items in a task list orproject.

1.7.1 complete

Description: Mark an item as complete.


HTTP Method: POST

Parameters:

item_id The id of the item to mark complete.


Example Request:

http://wedoist.com/API/Items/complete?item_id=256

{"date_due": null,"comment_seen": 0,"order": 1,"content": "Grow a beard.","comment_count": 0,"added_by": 23,"list_id": 93340,"is_unread": false,"project_id": 42,"id": 256,"date_due_string": "","posted": "Mon, 28 May 2012 17:36:03"}

1.7.2 get

Description: Get an item by its id.


HTTP Method: GET

Parameters:

1.7. Items 25


item_id The id of the item to fetch.


Example Request:

http://wedoist.com/API/Items/get?item_id=256


1.7.3 uncomplete

Description: Mark the item as uncomplete.


HTTP Method: GET

Parameters:

item_id The id of the item to mark uncomplete.


Example Request:

http://wedoist.com/API/Items/uncomplete?item_id=256


1.7.4 updateOrders

Description: Update the order of the items.


HTTP Method: POST



Parameters:

orders A JSON list of the item’s order.


Example Request:

http://wedoist.com/API/Items/updateOrders?orders=[3,4,1,2]

{’status’: ’ok’}

1.7.5 update

Description: Update an item.


HTTP Method: GET

Parameters:

item_id The id of the item to update.


due_date_string (optional) Set the date the item is due. Could be every day or every day @ 10.

Example Value: “”every day”“

content (optional) The content of the item.

Example Value: “Finish TPS reports.”

comment_seen (optional) Filter by seen comments.


Example Request:

http://wedoist.com/API/Items/update?item_id=256&due_date_string="every day"&content=Finish TPS reports.&comment_seen=false


1.7.6 getAllActive

Description:


HTTP Method: GET

1.7. Items 27


Parameters:

project_id The id of the project to fetch items from.


with_dates_only (optional) Return only active with due dates?


by_list_id (optional) The list id to limit the query by.


Example Request:

http://wedoist.com/API/Items/getAllActive?project_id=42&with_dates_only=false&by_list_id=23

{"93340": [{ "date_due": null,"comment_seen": 0,"order": 1,"content": "Grow a beard.","comment_count": 0,"added_by": 23,"list_id": 93340,"is_unread": false,"project_id": 42,"id": 256,"date_due_string": "","posted": "Mon, 28 May 2012 17:36:03"},]

}

1.7.7 add

Description:


HTTP Method: GET

Parameters:

content The content of the item.

Example Value: “Finish TPS reports.”

list_id The id of the list to add the item to.


due_date_string (optional) Set the date the item is due. Could be every day or every day @ 10.

Example Value: “none”

order (optional) The order of the item reltive to other items in this list.


ignore_date_error (optional) Ignore errors with the date.


note (optional) Add an optional note

Example Value: “Simple note.”



Example Request:

http://wedoist.com/API/Items/add?content=Finish TPS reports.&list_id=256&due_date_string=none&order=2&ignore_date_error=false&note=Simple note.


1.7.8 getActive

Description: Get all active items from a list.


HTTP Method: GET

Parameters:

list_id The id of the list to get the items from.


Example Request:

http://wedoist.com/API/Items/getActive?list_id=486

[ { "date_due": null,"comment_seen": 0,"order": 1,"content": "Grow a beard.","comment_count": 0,"added_by": 23,"list_id": 93340,"is_unread": false,"project_id": 42,"id": 546631,"date_due_string": "","posted": "Mon, 28 May 2012 17:36:03"

},]

1.7.9 query

Description: Query all of the projects items.


HTTP Method: GET

Parameters:

1.7. Items 29


project_id The project to query.


queries A JSON list of queries.

Example Value: “TPS Reports”

user_id (optional) Filter by user_id.


as_count (optional) Return only counts.


Example Request:

http://wedoist.com/API/Items/query?project_id=42&queries=TPS Reports&user_id=23&as_count=false


1.7.10 getCompleted

Description:


HTTP Method: GET

Parameters:

list_id The list to fetch completed items from.


offset (optional) The offset to the first returned item.


limit (optional) The maximum number of items to return.


Example Request:

http://wedoist.com/API/Items/getCompleted?list_id=256&offset=10&limit=30

{"items": [{ "date_due": null,"comment_seen": 0,"order": 1,"content": "Grow a beard.","comment_count": 0,



"added_by": 23,"list_id": 93340,"is_unread": false,"project_id": 42,"id": 256,"date_due_string": "","posted": "Mon, 28 May 2012 17:36:03"}]},

"users":[{"default_project": 42,"has_to_setup": false,"email": "[email protected]","number_of_projects": 2,"join_date": "Sun, 13 May 2012 20:20:53","avatar": "254bd140e8520bb8e25b5d2da98244b2","full_name": "Frank Wedoist","promo.guided_tour": true,"timezone": "America\/Chicago","id": 23}]

}

1.7.11 delete

Description:


HTTP Method: GET

Parameters:

item_id The id of the item to delete.


Example Request:

http://wedoist.com/API/Items/delete?item_id=256


1.8 Search

1.8.1 search

Description: Search a project.


1.8. Search 31


HTTP Method: GET

Parameters:

project_id The id of the project to search.


query A JSON list of the queries.


limit Limit the number of returned results.


offset The offset to the first returned result.


filter_by Can be of type status, chat_log, item, or document


sort_by How to sort the returned search items.

Example Value: “relevancy”

Example Request:

http://wedoist.com/API/Search/search?project_id=42&query=TPS Reports&limit=10&offset=30&filter_by=item&sort_by=relevancy

TODO: Json example of search.

1.9 Statuses

1.9.1 get

Description: Get a single status by id.


HTTP Method: GET

Parameters:

status_id The id of the status to fetch.


content_rendering (optional) Enable rendering of the content.


Example Request:

http://wedoist.com/API/Statuses/get?status_id=256&content_rendering=false

{ "posted": "Mon, 28 May 2012 18:18:43","type_id": 1,"comment_seen": 0,"poster_uid": 23,"content": "I grew my beard overnight!!","comment_count": 0,



"project_id": 42,"id": 256,"is_unread": false}

1.9.2 getAll

Description: Get all statuses in a project.


HTTP Method: GET

Parameters:

project_id The if of the project to fetch the statuses from.


type_id (optional) Can be of type status, chat_log, item, or document


poster_uid (optional) Filter the statuses by user_id


offset_date (optional) The date to offset the statuses by.

Example Value: “2012-3-24T23:59”

offset_id (optional) Offset to the first status returned.


limit (optional) Limit the number of statuses returned.




Example Request:

http://wedoist.com/API/Statuses/getAll?project_id=42&type_id=item&poster_uid=23&offset_date=2012-3-24T23:59&offset_id=14&limit=10&content_rendering=false

{ "users": { "42745": {"default_project": 44146,"stats": {"status_updates": 1,


"has_to_setup": false,"email": "[email protected]","number_of_projects": 2,"join_date": "Sun, 13 May 2012 20:20:53","last_login": "Mon, 28 May 2012 18:18:27","avatar": "254bd140e8520bb8e25b5d2da98244b2","full_name": "apitest","promo.guided_tour": true,"privilege": "holder","timezone": "America\/Chicago","id": 42}

},"statuses": [{ "posted": "Mon, 28 May 2012 18:18:43",

1.9. Statuses 33


"type_id": 1,"comment_seen": 0,"poster_uid": 23,"content": "I grew my beard overnight!!","comment_count": 0,"project_id": 42,"id": 256,"is_unread": false}]

}}

1.9.3 update

Description: Update a status.


HTTP Method: GET

Parameters:

status_id The id of the status to update.


content The content of the status.

Example Value: “I grew my beard overnight!!”

Example Request:

http://wedoist.com/API/Statuses/update?status_id=256&content=I grew my beard overnight!!

{ "posted": "Mon, 28 May 2012 18:18:43","type_id": 1,"comment_seen": 0,"poster_uid": 23,"content": "I grew my beard overnight!!","comment_count": 0,"project_id": 42,"id": 256,"is_unread": false}

1.9.4 getByDate

Description: Get a list of statuses by date.


HTTP Method: GET

Parameters:



date The date to filter by.






Example Request:

http://wedoist.com/API/Statuses/getByDate?project_id=42&date=2012-3-24T23:59&content_rendering=false






}}

1.9.5 add

Description: Add a status to a project.


HTTP Method: GET

Parameters:

project_id The if of the project to add the status to.






Example Request:

http://wedoist.com/API/Statuses/add?project_id=42&content=I grew my beard overnight!!&type_id=item

1.9. Statuses 35



1.9.6 delete

Description:


HTTP Method: GET

Parameters:

status_id The id of the status to delete.


Example Request:

http://wedoist.com/API/Statuses/delete?status_id=256


1.10 Comments

The comments api allows you to read, post, delete, and check for new comments either project or user wide.

1.10.1 get

Description: Fetch a comment by its id.


HTTP Method: GET

Parameters:

comment_id The id of the comment to be fetched.


Example Request:



http://wedoist.com/API/Comments/get?comment_id=256

{ "content": "A simple comment.","user_id": 42745,"type_id": "status","item_id": 967046,"project_id": 44146,"id": 368500,"posted": "Sun, 27 May 2012 18:06:43"

}

1.10.2 getUnread

Description: Get all unread comments from a project.


HTTP Method: GET

Parameters:

project_id The id of the target project.


as_count (optional) Return a count of the comments for display without fetchign them all.


as_ids (optional) Return the ids of the comments?


Example Request:

http://wedoist.com/API/Comments/getUnread?project_id=42&as_count=true&as_ids=false


}

1.10.3 markAsRead

Description: Mark comments as read.


HTTP Method: POST

Parameters:

project_id The target project.


1.10. Comments 37


item_ids The ids items to be marked as read.

Example Value: “[256,276]”

Example Request:

http://wedoist.com/API/Comments/markAsRead?project_id=42&item_ids=[256,276]


1.10.4 getAll

Description: Get all of the comments associated with the item.


HTTP Method: GET

Parameters:

type_id The type of comment. Can be of type status, chat_log, item, or document


item_id The id of the item.


update_comment_seen (optional) Update the fetched comments as seen?


include_users (optional) Include the users?


include_project_labels (optional) Include the project labels?


Example Request:

http://wedoist.com/API/Comments/getAll?type_id=item&item_id=256&update_comment_seen=false&include_users=false&include_project_labels=false

{ "project_id": 43,"comment_seen": 1,"comments": [{ "content": "A simple comment.",

"user_id": 42745,"type_id": "status","item_id": 967046,"project_id": 44146,"id": 368500,"posted": "Sun, 27 May 2012 18:06:43"

},]}

1.10.5 update

Description: Update a comments content.




HTTP Method: POST

Parameters:

comment_id The id of the comment to update.


content The content to update the comment with.

Example Value: “Sorry I mean SPT reports!”

Example Request:

http://wedoist.com/API/Comments/update?comment_id=256&content=Sorry I mean SPT reports!


}

1.10.6 markAsUnread

Description: Mark comments as unread.


HTTP Method: POST

Parameters:

project_id The target project.


item_ids The ids items to be marked as unread.

Example Value: “[256,276]”

Example Request:

http://wedoist.com/API/Comments/markAsUnread?project_id=42&item_ids=[256,276]


1.10.7 add

Description: Add a comment to an item.


HTTP Method: POST

Parameters:



1.10. Comments 39


type_id The type of comment. Can be of type status, chat_log, item, or document


item_id The item to attach the comment to.


content The content of the comment.

Example Value: “Those TPS reports look good Gordan.”

mark_as_unread_for_others (optional) Mark this as unread to the other users in the project?


notify_users_via_email Should a notification be sent via email?


Example Request:

http://wedoist.com/API/Comments/add?project_id=42&type_id=item&item_id=256&content=Those TPS reports look good Gordan.&mark_as_unread_for_others=0&notify_users_via_email=true


}

1.10.8 delete

Description: Delete a comment.


HTTP Method: POST

Parameters:

comment_id The id of the comment to delete.


Example Request:

http://wedoist.com/API/Comments/delete?comment_id=256


}



1.11 Labels

The labels API allows to to tag and fetch the labels on documents, comments, tasks, and statuses.

1.11.1 add

Description: Add a new label to the project.


HTTP Method: GET

Parameters:

project_id The id of the project to add the label to.


label The label to add.

Example Value: “asap!”

Example Request:

http://wedoist.com/API/Labels/add?project_id=42&label=asap!

{ "people_label": true,"user_id": 42,"name": "Frank Wedoist"}

1.11.2 getAll

Description: Get all the labels from a project.


HTTP Method: GET

Parameters:

project_id The id of the project to fetch the labels from.


Example Request:

http://wedoist.com/API/Labels/getAll?project_id=42

[{ "people_label": false,"name": "Everyone"},

{ "people_label": true,"user_id": 42,"name": "Frank Wedoist"}]

1.11.3 delete

Description: Delete a label from the project.


1.11. Labels 41


HTTP Method: GET

Parameters:

project_id The id of the project to delete the label from.


label The label to delete.

Example Value: “asap!”

Example Request:

http://wedoist.com/API/Labels/delete?project_id=42&label=asap!

{ "people_label": true,"user_id": 42,"name": "Frank Wedoist"}

1.12 Trends

1.12.1 getTrendGraph

Description:


HTTP Method: GET

Parameters:

project_id The id of the project to fetch the graph form.


user_id (optional) Limit the graph to a single user_id.


width (optional) The width of the graph.


height (optional) The height of the graph.


days (optional) How many days to show in the graph.


Example Request:

http://wedoist.com/API/Trends/getTrendGraph?project_id=42&user_id=23&width=350&height=200&days=7

"http://chart.apis.google.com/chart?cht=...

1.13 Emails

The e-mails API allows you to list the e-mail addresses of others in your project.



1.13.1 add

Description: Add an email.


HTTP Method: POST

Parameters:

email The email to add. Must be a valid email.


Example Request:

http://wedoist.com/API/Emails/[email protected]


1.13.2 getAll

Description: Get all emails.


HTTP Method: GET

Parameters:

None


Example Request:

http://wedoist.com/API/Emails/getAll?None=

1.13.3 remove

Description: Remove an email.


HTTP Method: POST

Parameters:

email The email to remove. Must be a valid email.


Example Request:

http://wedoist.com/API/Emails/[email protected]


1.13. Emails 43

mailto:[email protected]:[email protected]


1.14 DocumentCollections

The document collections API allows you to manipulate sets of documents in a project.

1.14.1 unarchive

Description: Unarchive a document collection.


HTTP Method: GET

Parameters:

id The id of the document collection to unarchive.


Example Request:

http://wedoist.com/API/DocumentCollections/unarchive?id=23

{"archived": false,"documents": [ {"description": "",

"title": "Simple google doc","url": "https://docs.google.com/doc","comment_seen": 0,"order": 2,"comment_count": 0,"date_created": "Sun, 27 May 2012 19:35:23","collection_id": 45935,"project_id": 44146,"id": 8856,"added_by": 42745,"is_unread": false}

],"name": "General","id": 45935,"is_inbox": true,"project_id": 44146,"order": 0}

1.14.2 move

Description:


HTTP Method: GET

Parameters:

id The id of the document collection to move.


to_project_id The project to move the document collection to.




Example Request:

http://wedoist.com/API/DocumentCollections/move?id=23&to_project_id=42




1.14.3 get

Description: Get a single document collection.


HTTP Method: GET

Parameters:

id The id of the document collection to fetch.


Example Request:

http://wedoist.com/API/DocumentCollections/get?id=23



],"name": "General","id": 45935,"is_inbox": true,

1.14. DocumentCollections 45


"project_id": 44146,"order": 0}

1.14.4 getAll

Description: Get all document collections in a project.


HTTP Method: GET

Parameters:

project_id The project id to fetch the document collections from.


Example Request:

http://wedoist.com/API/DocumentCollections/getAll?project_id=42

[ {"archived": false,"documents": [ {"description": "",


],"name": "General","id": 45935,"is_inbox": true,"project_id": 44146,"order": 0} ]

1.14.5 updateOrders

Description: Update the orders of the document collections.


HTTP Method: POST

Parameters:



orders A JSON list of the document collections’s order.


Example Request:



http://wedoist.com/API/DocumentCollections/updateOrders?project_id=32&orders=[3,4,1,2]

{"status": "ok"}

1.14.6 update

Description: Update a document collection.


HTTP Method: POST

Parameters:

id The id of the target document collection.


name (optional) A new name for the document collection.

Example Value: “Old Foo Docs”

order The order of this document collection.


Example Request:

http://wedoist.com/API/DocumentCollections/update?id=23&name=Old Foo Docs&order=2




1.14.7 archive

Description: Archive a document collection.


HTTP Method: GET

Parameters:

1.14. DocumentCollections 47


id The id of the document collection to archive.


Example Request:

http://wedoist.com/API/DocumentCollections/archive?id=12

{"archived": true,"documents": [ {"description": "",



1.14.8 getArchived

Description: Get all of the archived document collections from a project.


HTTP Method: GET

Parameters:

project_id The project to fetch the document collections from.


offset (optional) The offset of the starting document collection.


limit (optional) The maximum amount of archived document collections to return.


Example Request:

http://wedoist.com/API/DocumentCollections/getArchived?project_id=42&offset=10&limit=30

[ {"archived": false,"documents": [ {"description": "",

"title": "Simple google doc","url": "https://docs.google.com/doc","comment_seen": 0,"order": 2,"comment_count": 0,"date_created": "Sun, 27 May 2012 19:35:23",



"collection_id": 45935,"project_id": 44146,"id": 8856,"added_by": 42745,"is_unread": false}

],"name": "General","id": 45935,"is_inbox": true,"project_id": 44146,"order": 0} ]

1.14.9 delete

Description: Delete a document collection.


HTTP Method: POST

Parameters:

id The id of the target document collection.


Example Request:

http://wedoist.com/API/DocumentCollections/delete?id=23




1.15 Documents

The documents API allows you to post, retrieve, and delete documents to/from document collections in the project.

1.15. Documents 49


1.15.1 get

Description: Get a document


HTTP Method: GET

Parameters:

id The id of the document to fetch.


Example Request:

http://wedoist.com/API/Documents/get?id=257

{"description": "Simple description","title": "Simple google doc","url": "https://docs.google.com/doc","comment_seen": 0,"order": 2,"comment_count": 0,"date_created": "Sun, 27 May 2012 19:35:23","collection_id": 45935,"project_id": 42,"id": 8856,"added_by": 42745,"is_unread": false}

1.15.2 lock

Description: Lock a document.


HTTP Method: GET

Parameters:

id The id of the document to lock.


Example Request:

http://wedoist.com/API/Documents/lock?id=345

{"status": "ok"}

1.15.3 updateOrders

Description: Updates the document’s orders.


HTTP Method: GET

Parameters:



orders A JSON list of the document’s order.


Example Request:

http://wedoist.com/API/Documents/updateOrders?orders=[3,4,1,2]

{"status": "ok"}

1.15.4 update

Description: Update a document


HTTP Method: GET

Parameters:

id The id of the document to update.


title The title of the updated document


url The url of the updated document.

Example Value: “http://foo.com/tps“

description (optional) The description of the updated document.

Example Value: ” TPS reports.”

order The position of this document relative to others in this collection.


Example Request:

http://wedoist.com/API/Documents/update?id=345&title=TPS Reports&url=http://foo.com/tps&description= TPS reports.&order=2


1.15.5 add

Description: Add a document.


1.15. Documents 51

http://foo.com/tps


HTTP Method: GET

Parameters:

collection_id The collection to add the document to.


title The title of the document


url The url of the document.


description (optional) The description of the document.

Example Value: “March TPS reports.”

users_to_notify (optional) A list of users to notify.

Example Value: “[gary, sue, john]”

Example Request:

http://wedoist.com/API/Documents/add?collection_id=256&title=TPS Reports&url=http://foo.com/tps&description=March TPS reports.&users_to_notify=[gary, sue, john]


1.15.6 addAsNewVersion

Description: Add a new version of a document.


HTTP Method: GET

Parameters:

document_to_replace The id of the document to replace.


title The title of the updated document


url The url of the updated document.


description (optional) The description of the updated document.

Example Value: “March TPS reports.”


http://foo.com/tpshttp://foo.com/tps


users_to_notify (optional) A list of users to notify.

Example Value: “[gary, sue, john]”

Example Request:

http://wedoist.com/API/Documents/addAsNewVersion?document_to_replace=345&title=TPS Reports&url=http://foo.com/tps&description=March TPS reports.&users_to_notify=[gary, sue, john]


1.15.7 unlock

Description: Unlock a document.


HTTP Method: GET

Parameters:

id The id of the document to delete


Example Request:

http://wedoist.com/API/Documents/unlock?id=23

{"status": "ok"}

1.15.8 getCollectionDocuments

Description: Get all of the documents in a collection.


HTTP Method: GET

Parameters:

collection_id The id of the collection the documents should be fetched from.


Example Request:

http://wedoist.com/API/Documents/getCollectionDocuments?collection_id=23

1.15. Documents 53





1.15.9 delete

Description:


HTTP Method: GET

Parameters:

id The id of the document to delete.


Example Request:

http://wedoist.com/API/Documents/delete?id=23


1.16 Statuses

1.16.1 get

Description: Get a single status by id.




HTTP Method: GET

Parameters:

status_id The id of the status to fetch.




Example Request:

http://wedoist.com/API/Statuses/get?status_id=256&content_rendering=false


1.16.2 getAll

Description: Get all statuses in a project.


HTTP Method: GET

Parameters:





poster_uid (optional) Filter the statuses by user_id


offset_date (optional) The date to offset the statuses by.


offset_id (optional) Offset to the first status returned.


limit (optional) Limit the number of statuses returned.




1.16. Statuses 55


Example Request:

http://wedoist.com/API/Statuses/getAll?project_id=42&type_id=item&poster_uid=23&offset_date=2012-3-24T23:59&offset_id=14&limit=10&content_rendering=false






}}

1.16.3 update

Description: Update a status.


HTTP Method: GET

Parameters:

status_id The id of the status to update.




Example Request:

http://wedoist.com/API/Statuses/update?status_id=256&content=I grew my beard overnight!!

{ "posted": "Mon, 28 May 2012 18:18:43","type_id": 1,"comment_seen": 0,"poster_uid": 23,"content": "I grew my beard overnight!!","comment_count": 0,



"project_id": 42,"id": 256,"is_unread": false}

1.16.4 getByDate

Description: Get a list of statuses by date.


HTTP Method: GET

Parameters:



date The date to filter by.




Example Request:

http://wedoist.com/API/Statuses/getByDate?project_id=42&date=2012-3-24T23:59&content_rendering=false






}}

1.16. Statuses 57


1.16.5 add

Description: Add a status to a project.


HTTP Method: GET

Parameters:

project_id The if of the project to add the status to.






Example Request:

http://wedoist.com/API/Statuses/add?project_id=42&content=I grew my beard overnight!!&type_id=item


1.16.6 delete

Description:


HTTP Method: GET

Parameters:

status_id The id of the status to delete.


Example Request:

http://wedoist.com/API/Statuses/delete?status_id=256




1.17 Trends

1.17.1 getTrendGraph

Description:


HTTP Method: GET

Parameters:

project_id The id of the project to fetch the graph form.


user_id (optional) Limit the graph to a single user_id.


width (optional) The width of the graph.


height (optional) The height of the graph.


days (optional) How many days to show in the graph.


Example Request:

http://wedoist.com/API/Trends/getTrendGraph?project_id=42&user_id=23&width=350&height=200&days=7

"http://chart.apis.google.com/chart?cht=...

1.18 Using our Python API

1.18.1 Introduction

Wedoistapi is a minimal and full pythonic API for wedoist.com’s project management application. It allows Pythondevelopers access to the entire set of diverse features that Wedoist offers.

1.18.2 Install

You can install the Wedoist API using pip: pip install wedoistapi

Or you can download the package from the Python Package Index: http://pypi.python.org/pypi/wedoistapi

1.18.3 Examples:

1.17. Trends 59

http://pypi.python.org/pypi/wedoistapi


# Import the wedoist apifrom wedoistapi import Wedoist, WedoistHTTPAuth

# Authenticate with the HTTP auth class.auth = WedoistHTTPAuth(email="[email protected]", password="bar")

# Create an instance of the wedoist api using the user we authed to.wedoist = Wedoist(auth)

# You can access the user’s imformation in the auth objects# user_data propertydefault_project = auth.get_user_data()["default_project"]

# To make an api call we use the names from the official api docs.# To access all of the active items on our users default project at# wedoist.com/API/Items/getAllActive we make the following call with# the required POST data as keyword arguments:wedoist.Items.getAllActive(project_id=default_project)

Will return all active items as a list of python dictionaries, one for each item we fetched.

{ "date_format": 0,"default_project": 42,"has_to_setup": 0,"partition": 1,"number_of_projects": 1,"email": "[email protected]","time_format": 0,"join_date": "Sun, 13 May 2012 20:20:53","avatar": "254bd140e8520bb8e25b5d2da98244b2","full_name": "John Cardholder","timezone": "America\/Chicago","id": 23

}

Any API function call be called as presented in the official API documentation with the required POST data passed askeyword arguments.

# API call: wedoist.com/API/Projects/getAllwedoist.Projects.getAll()

# API call: wedoist.com/API/Projects/getwedoist.Projects.get(project_id=42)

1.18.4 Error Handling:

More sophisticated error handling is in the works. For now the API uses straight urllib2 calls to interactwith Wedoist’s servers. As such it throws generic HTTPError when a request can not be completed. See:http://docs.python.org/library/urllib2.html#urllib2.HTTPError

http://docs.python.org/library/urllib2.html#urllib2.HTTPError