Query Description items
==========================

    The Description endpoint allows you to submit GET requests to retrieve all of the Description items and their attributes.

    .. http:get:: /mping/api/v2/description

        Get all available Descriptions

        **Example request**

        .. sourcecode:: http

            GET /mping/api/v2/description HTTP/1.0
            Host: mping.ou.edu
            Accept: application/json

        :reqheader Accept-Language: Optional: if need Description entries in another language supported by the API
        :reqheader Content-Type: Optional: requested format type of response (default is json)

        **Example response**

        .. sourcecode:: http

            HTTP/1.0 200 OK
            Date: Wed, 11 Feb 2015 20:00:59 GMT
            Server: WSGIServer/0.1 Python/2.7.9
            Vary: Accept, Accept-Language, Cookie
            Content-Type: application/json
            Content-Language: en-us
            Allow: GET, HEAD, OPTIONS

            {
                "count": 46, 
                "next": null, 
                "previous": null, 
                "results": [
                    {
                        "id": 1, 
                        "name": "NULL", 
                        "api_access": "public", 
                        "active": true, 
                        "category": {
                            "id": 8, 
                            "name": "Test", 
                            "active": true
                        }
                    }, 
                    {
                        "id": 2, 
                        "name": "NULL", 
                        "api_access": "public", 
                        "active": true, 
                        "category": {
                            "id": 9, 
                            "name": "None", 
                            "active": true
                        }
                    }, 
                    {
                        "id": 3, 
                        "name": "Rain", 
                        "api_access": "public", 
                        "active": true, 
                        "category": {
                            "id": 1, 
                            "name": "Rain/Snow", 
                            "active": true
                        }
                    }, 
                    {
                        "id": 4, 
                        "name": "Freezing Rain", 
                        "api_access": "public", 
                        "active": true, 
                        "category": {
                            "id": 1, 
                            "name": "Rain/Snow", 
                            "active": true
                        }
                    }, 
            
        :statuscode 200: no error
        :resjson int count: The total number of Descriptions matching your query
        :resjson string next: provides url to get next page of results otherwise null
        :resjson string previous: provides url to get previous page of results otherwise null
        :resjson array results: array of mPING Descriptions matching your query
        :>jsonarr int id: the primary id of the Description
        :>jsonarr string name: name of the Description
        :>jsonarr string api_access: will be either "public" or "private"
        :>jsonarr bool active: whether the Description is active or not
        :>jsonarr object category: the Category object this Description belongs to
        :>jsonarr int [category id]: the primary id of the Category
        :>jsonarr string [category name]: name of the Category
        :>jsonarr bool [category active]: whether the Category is active or not