Hackathon

Carpenter

Objectives

• Open source a stand-alone JavaScript library
• Create a marketing/docs site for the JavaScript library
• Create a Java library for easily implementing a Carpenter-compliant JSON API
• Create a carpenter-rails gem for easily implementing a Carpenter-compliant JSON API

API

Request

GET /index.json

• sort_by - String - The attribute name to sort by, followed by the direction: username asc
• per_page - Number - The number of results per page (default: 20)
• page - Number - The page number of the results to fetch (default: 1)

Response

Each JSON response includes an array of the objects to be displayed (collection), plus the following metadata attributes:

• total_pages - Number - The total number of pages in the result.
• total_count - Number - The total number of records in the result.

Example response:

{
    "collection": [
        {
            "username": "joe",
            "email_address": "joe@vennix.com"
        },
        {
            "username": "matt",
            "email_address": "matt@buck.com"
        }
    ],
    "total_pages": 1,
    "total_count": 2
}