User collection

Read-only

This resource type refers to the collection of registered users.

GET /api/v1/users/

Synopsis:Gets the list of registered users.

Example request:

GET /api/v1/users/ HTTP/1.1
Host: localhost:8000
Accept: application/vnd.collection+json

Example response:

HTTP/1.1 200 OK
Allow: GET
Content-Type: application/vnd.collection+json

{
    "collection": {
        "href": "https://localhost:8000/api/v1/users/",
        "items": [
            {
                "data": [
                    {
                        "name": "username",
                        "value": "chris"
                    }
                ],
                "href": "https://localhost:8000/api/v1/users/1/"
            },
            {
                "data": [
                    {
                        "name": "username",
                        "value": "jbernal"
                    }
                ],
                "href": "https://localhost:8000/api/v1/users/2/",
                "links": [
                    {
                        "href": "https://localhost:8000/api/v1/33/",
                        "rel": "feed"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/34/",
                        "rel": "feed"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/35/",
                        "rel": "feed"
                    },
                    {
                        "href": "https://localhost:8000/api/v1/36/",
                        "rel": "feed"
                    }
                ]
            },
            {
                "data": [
                    {
                        "name": "username",
                        "value": "jbernal1"
                    }
                ],
                "href": "https://localhost:8000/api/v1/users/3/"
            }
        ],
        "links": [],
        "version": "1.0"
    }
}

Request Headers:  

• Accept – application/vnd.collection+json

Response Headers:  

• Content-Type – application/vnd.collection+json

Status Codes:

• 200 OK – no error
• 401 Unauthorized – authentication credentials were not provided

Properties (API semantic descriptors):

• user item properties

Link Relations:

• user item link relations