aboutsummaryrefslogtreecommitdiff
path: root/doc/collection-version.rst
blob: 025295dd36b5c0c53ab03383c1732cab2b7170a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
version
-------

GET
***

.. http:get:: /version

 Provide the version number of the software running.

 :reqheader Accept-Encoding: Accept the ``gzip`` coding.

 :resheader Content-Type: Will be ``application/json; charset=UTF-8``.

 :status 200: Resuslts found.

 .. note::

    This collection does not require authentication.

 **Example Requests**

 .. sourcecode:: http

    GET /version HTTP/1.1
    Host: api.armcloud.us
    Accept: */*

 **Example Responses**

 .. sourcecode:: http

    HTTP/1.1 200 OK
    Vary: Accept-Encoding
    Date: Mon, 24 Nov 2014 18:08:12 GMT
    Content-Type: application/json; charset=UTF-8

    {
        "code": 200,
        "result":
        [
            {
                "version": "2014.11",
                "full_version": "2014.11"
            }
        ]
    }

POST
****

.. caution::
    Not implemented. Will return a :ref:`status code <http_status_code>`
    of ``501``.


DELETE
******

.. caution::
    Not implemented. Will return a :ref:`status code <http_status_code>`
    of ``501``.