Status

Fields

text
status text
created-at
status creation time
user_id
status author identifier number

Methods

get_all

returns all status updates of a given user

Parameters

  • id: USER_ID (unique user identifier) - 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/statuses/get_all/2 
http://company_alias.goplanapp.com/api/statuses/get_all?format=json&callback=handlerFunction&id=2

Output Formats

  • XML

    
    <?xml version="1.0" encoding="UTF-8"?>
    <statuses type="array">
    	<status>
    		<created-at type="datetime">2009-03-20T14:22:31+00:00</created-at>
    		<text>ngngngn</text>
    		<user-id type="integer">1</user-id>
    	</status>
    	<status>
    		<created-at type="datetime">2009-03-17T15:08:42+00:00</created-at>
    		<text>testing
    			goplan with
    			enters</text>
    		<user-id type="integer">1</user-id>
    	</status>
    	<status>
    		<created-at type="datetime">2009-03-17T15:08:24+00:00</created-at>
    		<text>testing goplan
    		</text>
    		<user-id type="integer">1</user-id>
    	</status>
    </statuses>
        
  • JSON

    
    handlerFunction([{"status": {"created_at": "2009/03/20 14:22:31 +0000", "text": "ngngngn", "user_id": 1}}, {"status": {"created_at": "2009/03/17 15:08:42 +0000", "text": "testing goplan\r\nwith \r\nenters", "user_id": 1}}, {"status": {"created_at": "2009/03/17 15:08:24 +0000", "text": "testing goplan\r\n", "user_id": 1}}])
    		

get_last

returns the last status update of a given user

Parameters

  • id: USER_ID (unique user identifier) - 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/statuses/get_last/2 
http://company_alias.goplanapp.com/api/statuses/get_last?format=json&&id=1

Output Formats

  • XML

    
    <?xml version="1.0" encoding="UTF-8"?>
    <status>
    	<created-at type="datetime">2009-03-20T14:22:31+00:00</created-at>
    	<text>ngngngn</text>
    	<user-id type="integer">1</user-id>
    </status>
        
  • JSON

    
    {"status": {"created_at": "2009/03/24 22:00:34 +0000", "text": "ngngngn", "user_id": 1}}
    		

update

creates a new status for the current user and returns it

Parameters

  • text: status_TEXT (text of the new status) - mandatory. you can hotlink to a specific task or ticket if the text is in this form: PROJECT_ALIAS:ITEM_TYPE:ITEM_CID, i.e.: goplan:ticket:4
  • 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/statuses/update - pass the other parameters by POST
http://company_alias.goplanapp.com/api/statuses/update?format=json&callback=handlerfunction&text=working on something

Output Formats

  • XML

    
    <?xml version="1.0" encoding="UTF-8"?>
    <status>
    	<created-at type="datetime">2009-03-20T14:22:31+00:00</created-at>
    	<text>ngngngn</text>
    	<user-id type="integer">1</user-id>
    </status>
        
  • JSON

    
    han{"status": {"created_at": "2009/03/24 22:00:34 +0000", "text": "ngngngn", "user_id": 1}}
    		

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