Users Resource

Users Resource

API Documentation

Data Model

The User resource is represented in the database as such:

{
   id: <Type.Integer.unique>
   name: <Type.String.unique>
}

Routes, Requests, Responses

CREATE

POST /users

Creates a new User object.

Expects a request.payload with a single attribute, name, which is a unique String representing the user's name, e.g.:

{
   name: "sedge" 
}

READ

GET /users/

Retrieves a collection of User objects.

Example response:

[
  {
    "id": 1,
    "name": "ag_dubs"
  },
  {
    "id": 2,
    "name": "k88hudson"
  },
  {
    "id": 3,
    "name": "jbuckca"
   }
]

GET /users/{id}

Retrieves a single User object.

Example response:

// GET /users/1

{
  "id": 1,
  "name": "ag_dubs"
}

UPDATE

PUT /users/{id}

Updates a User object based on its id attribute.

Expects a request.payload with a single attribute, name, which is a unique String representing the user's name, e.g.:

// PUT /users/4

{
   name: "gideon" 
}

DELETE

DELETE /users/{id}

Deletes a User object based on its id attribute.