Assembla DocumentationPublic Space

What is Rest (Representational State Transfer)?: It's an architectural style, not a standard. Find out more in the Wikipedia or read the following article if you want to know about REST in Rails

What do you need to access our REST API? You just need to know how to send  HTTP requests with basic authentication to our servers from your application.

TABLE OF CONTENTS

• Scrum Report Rest API
  • Scrum Report XML Representation
  • Latest Scrum Reports (GET)
  • Scrum Reports On Date (GET)

Scrum Report XML Representation

<scrum-report>
     <created-at>2007-11-27T13:08:21+02:00</created-at>
     <space-id>b6nRoCPC0r2Oq0aaeP0Qfc</space-id>
     <user-id>brm3n0eOur3jHuaaeP0Qfc</user-id>
     <what-i-did>worked on ticket #1000 </what-i-did>
     <what-i-will-do>work on tikcets: #1001, #1002, #1003</what-i-will-do>
     <roadblocks>No roadblocks</roadblocks>
</scrum-report>

Latest Scrum Reports (GET)

To access latest scrum reports you need to send a GET request to: http://ww.assembla.com/spaces/scrum/index/<space_id>?format=xml, where space_id is the id of the spacecontaining scrum reports.

Response:

<scrum-reports>
<scrum-report>
          <created-at>2007-11-27T13:08:21+02:00</created-at>
          <space-id>b6nRoCPC0r2Oq0aaeP0Qfc</space-id>
          <user-id>brm3n0eOur3jHuaaeP0Qfc</user-id>
          <what-i-did>worked on ticket #1000 </what-i-did>
          <what-i-will-do>work on tikcets: #1001, #1002, #1003</what-i-will-do>
          <roadblocks>No roadblocks</roadblocks>
</scrum-report>

<scrum-report>
          <created-at>2007-11-27T13:08:21+02:00</created-at>
          <space-id>b6nRoCPC0r2Oq0aaeP0Qfc</space-id>
          <user-id>brm3n0eOur3jHuaaeP0Qfc</user-id>
          <what-i-did>worked on ticket #1000 </what-i-did>
          <what-i-will-do>work on tikcets: #1001, #1002, #1003</what-i-will-do>
          <roadblocks>No roadblocks</roadblocks>
</scrum-report>

<scrum-report>
          <created-at>2007-11-27T13:08:21+02:00</created-at>
          <space-id>b6nRoCPC0r2Oq0aaeP0Qfc</space-id>
          <user-id>brm3n0eOur3jHuaaeP0Qfc</user-id>
          <what-i-did>worked on ticket #1000 </what-i-did>
          <what-i-will-do>work on tikcets: #1001, #1002, #1003</what-i-will-do>
          <roadblocks>No roadblocks</roadblocks>
</scrum-report>

</scrum-reports>

Scrum Reports On Date (GET)

To access latest scrum reports you need to send a GET request to: http://localhost:3000/spaces/scrum/report/<space_id>?for_date=<date>&format=xml, where space_id is the id of the spacecontaining scrum reports and date is the specific date for which you want to request scrum reports.

Response:

<scrum-reports>
     <scrum-report>
          <created-at>2007-11-27T13:08:21+02:00</created-at>
          <space-id>b6nRoCPC0r2Oq0aaeP0Qfc</space-id>
          <user-id>brm3n0eOur3jHuaaeP0Qfc</user-id>
          <what-i-did>worked on ticket #1000 </what-i-did>
          <what-i-will-do>work on tikcets: #1001, #1002, #1003</what-i-will-do>
          <roadblocks>No roadblocks</roadblocks>
     </scrum-report>

     <scrum-report>
          <created-at>2007-11-27T13:08:21+02:00</created-at>
          <space-id>b6nRoCPC0r2Oq0aaeP0Qfc</space-id>
          <user-id>brm3n0eOur3jHuaaeP0Qfc</user-id>
          <what-i-did>worked on ticket #1000 </what-i-did>
          <what-i-will-do>work on tikcets: #1001, #1002, #1003</what-i-will-do>
          <roadblocks>No roadblocks</roadblocks>
     </scrum-report>

<scrum-report>
          <created-at>2007-11-27T13:08:21+02:00</created-at>
          <space-id>b6nRoCPC0r2Oq0aaeP0Qfc</space-id>
          <user-id>brm3n0eOur3jHuaaeP0Qfc</user-id>
          <what-i-did>worked on ticket #1000 </what-i-did>
          <what-i-will-do>work on tikcets: #1001, #1002, #1003</what-i-will-do>
          <roadblocks>No roadblocks</roadblocks>
     </scrum-report>
</scrum-reports>

</scrum-reports>