Projects

Fields

alias
company's unique project identifier string
name
project's name
description
project's description
currency
project's currency
created-at
project's creation time

updated-at
project's last updated time

Methods

get_all

returns all projects from a company

Parameters

  • 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/api/projects/get_all
http://company_alias.goplanapp.com/api/projects/get_all?format=json&callback=handlerFunction

Output Formats

  • XML

    
    <?xml version="1.0" encoding="UTF-8"?>
    <projects type="array">
    <project>
    <alias>goplan</alias>
    <created-at type="datetime">2009-03-17T15:20:30+00:00</created-at>
    <description></description>
    <name>xxxxx</name>
    <updated-at type="datetime">2009-03-30T15:15:50+01:00</updated-at>
    </project>
    <project>
    <alias>gssggs</alias>
    <created-at type="datetime">2009-03-18T17:45:55+00:00</created-at>
    <description></description>
    <name>gsgsgs</name>
    <updated-at type="datetime">2009-03-18T17:45:55+00:00</updated-at>
    </project>
    <project>
    <alias>twtt</alias>
    <created-at type="datetime">2009-03-19T16:07:11+00:00</created-at>
    <description></description>
    <name>twtwt</name>
    <updated-at type="datetime">2009-03-19T16:07:11+00:00</updated-at>
    </project>
    </projects>
  • JSON

    
    handlerFunction([{"project": {"name": "xxxxx", "created_at": "2009/03/17 15:20:30 +0000", "updated_at": "2009/03/30 15:15:50 +0100", "alias": "goplan", "description": ""}}, {"project": {"name": "gsgsgs", "created_at": "2009/03/18 17:45:55 +0000", "updated_at": "2009/03/18 17:45:55 +0000", "alias": "gssggs", "description": ""}}, {"project": {"name": "twtwt", "created_at": "2009/03/19 16:07:11 +0000", "updated_at": "2009/03/19 16:07:11 +0000", "alias": "twtt", "description": ""}}])
    	

get

returns a project from a company

Parameters

  • id: 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/api/projects/get/projectalias
http://company_alias.goplanapp.com/api/projects/get?id=projectalias&format=json&callback=handler

Output Formats

  • XML

    
    <?xml version="1.0" encoding="UTF-8"?>
    <project>
    <alias>goplan</alias>
    <created-at type="datetime">2009-03-17T15:20:30+00:00</created-at>
    <description></description>
    <name>goplan project</name>
    <updated-at type="datetime">2009-03-30T15:15:50+01:00</updated-at>
    </project>
  • JSON

    
    handlerFunction({"project": {"name": "goplan project", "created_at": "2009/03/17 15:20:30 +0000", "updated_at": "2009/03/30 15:15:50 +0100", "alias": "goplan", "description": ""}})
    	

create

creates a new project and returns it

Parameters

  • project_info[name]: PROJECT_NAME (name of the new project)- mandatory
  • project_info[alias]: PROJECT_ALIAS (alias of the new project)- mandatory
  • project_info[description]: PROJECT_DESCRIPTION (description of the new project)- not 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/api/projects/create
http://company_alias.goplanapp.com/api/projects/create?format=json&callback=handlerfunction&project_info[name]=test&project_info[alias]=test&project_info[description]=test

Output Formats

  • XML

    
    <?xml version="1.0" encoding="UTF-8"?>
    <project>
    <alias>goplan</alias>
    <created-at type="datetime">2009-03-17T15:20:30+00:00</created-at>
    <description></description>
    <name>goplan project</name>
    <updated-at type="datetime">2009-03-30T15:15:50+01:00</updated-at>
    </project>
  • JSON

    
    handlerFunction({"project": {"name": "goplan project", "created_at": "2009/03/17 15:20:30 +0000", "updated_at": "2009/03/30 15:15:50 +0100", "alias": "goplan", "description": ""}})
    	

destroy

deletes a project from a company and returns it

Parameters

  • id: 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/api/projects/destroy/projectalias
http://company_alias.goplanapp.com/api/projects/destroy?id=projectalias&format=json&callback=handler

Output Formats

  • XML

    
    <?xml version="1.0" encoding="UTF-8"?>
    <project>
    <alias>goplan</alias>
    <created-at type="datetime">2009-03-17T15:20:30+00:00</created-at>
    <description></description>
    <name>goplan project</name>
    <updated-at type="datetime">2009-03-30T15:15:50+01:00</updated-at>
    </project>
  • JSON

    
    handlerFunction({"project": {"name": "goplan project", "created_at": "2009/03/17 15:20:30 +0000", "updated_at": "2009/03/30 15:15:50 +0100", "alias": "goplan", "description": ""}})
    	

update

updates an existing project and returns it

Parameters

  • id: PROJECT_ALIAS (alias of a specific project)- mandatory
  • project_info[name]: NEW_PROJECT_NAME (new name of the project)- not mandatory
  • project_info[alias]: NEW_PROJECT_ALIAS (new alias of the project)- not mandatory
  • project_info[description]: NEW_PROJECT_DESCRIPTION (new description of the project)- not 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/api/projects/update/projectalias
http://company_alias.goplanapp.com/api/projects/update?id=projectalias&format=json&callback=handlerfunction&project_info[name]=test&project_info[alias]=test&project_info[description]=test

Output Formats

  • XML

    
    <?xml version="1.0" encoding="UTF-8"?>
    <project>
    <alias>goplan</alias>
    <created-at type="datetime">2009-03-17T15:20:30+00:00</created-at>
    <description></description>
    <name>goplan project</name>
    <updated-at type="datetime">2009-03-30T15:15:50+01:00</updated-at>
    </project>
  • JSON

    
    handlerFunction({"project": {"name": "goplan project", "created_at": "2009/03/17 15:20:30 +0000", "updated_at": "2009/03/30 15:15:50 +0100", "alias": "goplan", "description": ""}})
    	

Follow us on Twitter and Facebook. Talk to us and Get Satisfaction.

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