Representational State Transfer (REST)

The following illustrates the retrieval of blog posts by a specific user and identified by a specific tag. The general structure is:

GET /users/(int: user_id_)/posts/(tag)

Example request:

GET /users/123/posts/web HTTP/1.1
Host: example.com
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/javascript

[
  {
    "post_id": 12345,
    "author_id": 123,
    "tags": ["server", "web"],
    "subject": "I tried JavaScript"
  },
  {
    "post_id": 12346,
    "author_id": 123,
    "tags": ["html5", "standards", "web"],
    "subject": "We moved to HTML 5"
  }
]
Query Parameters

  • sort – one of hit, created-at

  • offset – offset number. default is 0

  • limit – limit number. default is 30

Request Headers

  • Accept – the response content type depends on Accept header

  • Authorization – optional OAuth token to authenticate

Response Headers
Status Codes