returns all users in the company or in a project
http://company_alias.goplanapp.com/api/users/get_all
http://company_alias.goplanapp.com/api/users/get_all?format=json&callback;=handlerFunction
XML
<?xml version="1.0" encoding="UTF-8"?>
<users type="array">
<user>
<alias>mary</alias>
<id type="integer">1</id>
<created-at type="datetime">2009-03-03T19:46:18+00:00</created-at>
<email>[email protected]</email>
<name>Mary</name>
<picture-url>http://goplanapp.com/content/server.jpg</picture-url>
<time-zone>Lisbon</time-zone>
<updated-at type="datetime">2009-04-13T13:35:13+01:00</updated-at>
<user-type type="integer">0</user-type>
</user>
<user>
<id type="integer">2</id>
<alias>robert</alias>
<created-at type="datetime">2009-03-03T20:40:43+00:00</created-at>
<email>[email protected]</email>
<name>Robert</name>
<picture-url>http://goplanapp.com/content/server.jpg</picture-url>
<time-zone>Lisbon</time-zone>
<updated-at type="datetime">2009-04-02T17:24:48+01:00</updated-at>
<user-type type="integer">0</user-type>
</user>
<user>
<id type="integer">3</id>
<alias>Roger</alias>
<created-at type="datetime">2009-03-04T16:14:01+00:00</created-at>
<email>[email protected]</email>
<name>roger</name>
<picture-url>http://goplanapp.com/content/server.jpg</picture-url>
<time-zone>UTC</time-zone>
<updated-at type="datetime">2009-04-13T15:58:45+01:00</updated-at>
<user-type type="integer">0</user-type>
</user>
</users>
JSON
handlerFunction([{"user": {"id": 1, "name": "Mary", "updated_at": "2009/03/03 18:48:59 +0000", "picture_url": "http://goplanapp.com/content/server.jpg", "user_type": 0, "time_zone": "Lisbon", "alias": "mary", "email": "[email protected]", "created_at": "2009/03/03 18:48:59 +0000"}}, {"user": {"id": 1, "name": "Robert", "updated_at": "2009/04/09 16:16:58 +0100", "picture_url": "http://goplanapp.com/content/server.jpg", "user_type": 0, "time_zone": "UTC", "alias": "Robert", "email": "[email protected]", "created_at": "2009/03/03 18:49:43 +0000"}}, {"user": {"id": 1, "name": "Roger", "updated_at": "2009/04/13 13:35:13 +0100", "picture_url": "http://goplanapp.com/content/server.jpg", "user_type": 0, "time_zone": "Lisbon", "alias": "roger", "email": "[email protected]", "created_at": "2009/03/03 19:46:18 +0000"}}])
returns a specific user
http://company_alias.goplanapp.com/api/users/get/2
http://company_alias.goplanapp.com/api/users/get?id=2&format;=json&callback;=handlerFunction
XML
<?xml version="1.0" encoding="UTF-8"?>
<user>
<alias>roger</alias>
<id type="integer">1</id>
<created-at type="datetime">2009-03-03T19:46:18+00:00</created-at>
<email>[email protected]</email>
<name>Roger</name>
<picture-url>http://goplanapp.com/content/server.jpg</picture-url>
<time-zone>Lisbon</time-zone>
<updated-at type="datetime">2009-04-13T13:35:13+01:00</updated-at>
<user-type type="integer">0</user-type>
</user>
JSON
{"user": {"id": 1, "name": "Mary", "updated_at": "2009/03/03 18:48:59 +0000", "picture_url": "http://goplanapp.com/content/server.jpg", "user_type": 0, "time_zone": "Lisbon", "alias": "mary", "email": "[email protected]", "created_at": "2009/03/03 18:48:59 +0000"}}
creates a new internal user or makes an external user -> internal and returns it
http://company_alias.goplanapp.com/api/users/add_to_company pass other parameter by post
http://company_alias.goplanapp.com/api/users/add_to_company?id=2&format;=json&callback;=handlerFunction (etc)
XML
<?xml version="1.0" encoding="UTF-8"?>
<user>
<alias>roger</alias>
<id type="integer">1</id>
<created-at type="datetime">2009-03-03T19:46:18+00:00</created-at>
<email>[email protected]</email>
<name>Roger</name>
<picture-url>http://goplanapp.com/content/server.jpg</picture-url>
<time-zone>Lisbon</time-zone>
<updated-at type="datetime">2009-04-13T13:35:13+01:00</updated-at>
<user-type type="integer">0</user-type>
</user>
JSON
{"user": {"id": 1, "name": "Mary", "updated_at": "2009/03/03 18:48:59 +0000", "picture_url": "http://goplanapp.com/content/server.jpg", "user_type": 0, "time_zone": "Lisbon", "alias": "mary", "email": "[email protected]", "created_at": "2009/03/03 18:48:59 +0000"}}
creates a new external user and returns it
FIXME
http://company_alias.goplanapp.com/project_alias/api/users/add_to_project pass other parameter by post
http://company_alias.goplanapp.com/api/users/add_to_project?project=project_alias&format;=json&callback;=handlerFunction (etc)
XML
<?xml version="1.0" encoding="UTF-8"?>
<user>
<alias>roger</alias>
<id type="integer">1</id>
<created-at type="datetime">2009-03-03T19:46:18+00:00</created-at>
<email>[email protected]</email>
<name>Roger</name>
<picture-url>http://goplanapp.com/content/server.jpg</picture-url>
<time-zone>Lisbon</time-zone>
<updated-at type="datetime">2009-04-13T13:35:13+01:00</updated-at>
<user-type type="integer">0</user-type>
</user>
JSON
{"user": {"id": 1, "name": "Mary", "updated_at": "2009/03/03 18:48:59 +0000", "picture_url": "http://goplanapp.com/content/server.jpg", "user_type": 0, "time_zone": "Lisbon", "alias": "mary", "email": "[email protected]", "created_at": "2009/03/03 18:48:59 +0000"}}
revokes the user's access to a company
http://company_alias.goplanapp.com/api/users/remove_from_company/3
http://company_alias.goplanapp.com/api/users/remove_from_company?id=3&format;=json&callback;=handlerFunction
XML
<?xml version="1.0" encoding="UTF-8"?>
<user>
<alias>roger</alias>
<id type="integer">1</id>
<created-at type="datetime">2009-03-03T19:46:18+00:00</created-at>
<email>[email protected]</email>
<name>Roger</name>
<picture-url>http://goplanapp.com/content/server.jpg</picture-url>
<time-zone>Lisbon</time-zone>
<updated-at type="datetime">2009-04-13T13:35:13+01:00</updated-at>
<user-type type="integer">0</user-type>
</user>
JSON
{"user": {"id": 1, "name": "Mary", "updated_at": "2009/03/03 18:48:59 +0000", "picture_url": "http://goplanapp.com/content/server.jpg", "user_type": 0, "time_zone": "Lisbon", "alias": "mary", "email": "[email protected]", "created_at": "2009/03/03 18:48:59 +0000"}}
revokes the user's access to a project
http://company_alias.goplanapp.com/project_alias/api/users/remove_from_project/3
http://company_alias.goplanapp.com/api/users/remove_from_project?project=project_alias&id;=3&format;=json&callback;=handlerFunction
XML
<?xml version="1.0" encoding="UTF-8"?>
<user>
<alias>roger</alias>
<id type="integer">1</id>
<created-at type="datetime">2009-03-03T19:46:18+00:00</created-at>
<email>[email protected]</email>
<name>Roger</name>
<picture-url>http://goplanapp.com/content/server.jpg</picture-url>
<time-zone>Lisbon</time-zone>
<updated-at type="datetime">2009-04-13T13:35:13+01:00</updated-at>
<user-type type="integer">0</user-type>
</user>
JSON
{"user": {"id": 1, "name": "mary", "updated_at": "2009/03/03 18:48:59 +0000", "picture_url": "http://goplanapp.com/content/server.jpg", "user_type": 0, "time_zone": "Lisbon", "alias": "mary", "email": "[email protected]", "created_at": "2009/03/03 18:48:59 +0000"}}
Follow us on Twitter and Facebook. Talk to us and Get Satisfaction.
Goplan is a product of Webreakstuff | Contact support | Terms of Service