.. -*- mode: rst -*-

.. _roll_calls:

==========
Roll calls
==========

A roll call is a recorded vote of each member of a chamber. Some roll
call votes are required by law or chamber rules, but sometimes a
chamber member may request a roll call vote to be taken and recorded.

Rollcalls are, similarly to :ref:`fiscal notes <fiscal_notes>`,
sub-resources of bills and as such discoverable from the :ref:`bill
version <bills>` representation.


Resources
=========

.. include:: ../resource_maps/roll_calls.txt

Supported Filter Parameters
===========================

.. csv-table::
   :header: "Parameter", "Description"

    ``bill``,"Searches for roll calls associated with a particular bill number (e.g. HB1001) or target id (e.g. HB1001.02.COMH)"
    ``type``,"Returns roll calls of the given type, where type can be one of 'amendment', 'conference-committee-report', or 'bill'."


Examples
========

Get a particular roll call:

.. code-block:: bash

    curl -i \
         -X GET \
         -H "Accept: application/pdf" \
         https://api.iga.in.gov/2014/rollcalls/MTE4LzIwMTQvY2FiaW5ldC9iaWxscy9ob3VzZS9IQjEwMDQvcm9sbGNhbGwvSEIxMDA0LjAzLkVOR0guMjEucGRmLmh0bWw=

.. code-block:: javascript

    {
        "target": "SB0316.03.ENGS", 
        "chamber": {
            "link": "/2015/chambers/senate", 
            "name": "Senate"
        }, 
        "rollcall_number": "147", 
        "results": {
            "yea": 50, 
            "nay": "0"
        }, 
        "link":
            "/2015/rollcalls/MTE5LzIwMTUvY2FiaW5ldC9iaWxscy9zZW5hdGUvU0IwMzE2L3JvbGxjYWxsL1NCMDMxNi4xNDcucGRmLmh0bWw=", 
        "revno": 285824, 
        "pdfDownloadLink":
            "/2015/rollcalls/MTE5LzIwMTUvY2FiaW5ldC9iaWxscy9zZW5hdGUvU0IwMzE2L3JvbGxjYWxsL1NCMDMxNi4xNDcucGRmLmh0bWw=?format=pdf"
    }
              
Filter roll calls by bill number:

.. code-block:: bash

    curl -i \
         -X GET \
         -H "Accept: application/pdf" \
         https://api.iga.in.gov/2014/rollcalls?bill=HB1001

.. code-block:: javascript

    {
        "availableFilters": [
            "type",
            "bill"
        ],
        "appliedFilters": {
            "bill": "BILL"
        },
        "itemCount": 4,
        "items": [
            {
                "target": "HB1001.03.COMS",
                "chamber": {
                    "link": "/2014/chambers/senate",
                    "name": "Senate"
                },
                "rollcall_number": "276",
                "results": null,
                "link": "/2014/rollcalls/MTE4LzIwMTQvY2FiaW5ldC9iaWxscy9ob3VzZS9IQjEwMDEvcm9sbGNhbGwvSEIxMDAxLjAzLkNPTVMuMjc2LnBkZi5odG1s",
                "type": "BILL"
            },
            {
                "target": "HB1001.03.COMS.AMS001",
                "chamber": {
                    "link": "/2014/chambers/senate",
                    "name": "Senate"
                },
                "rollcall_number": "249",
                "results": null,
                "link": "/2014/rollcalls/MTE4LzIwMTQvY2FiaW5ldC9iaWxscy9ob3VzZS9IQjEwMDEvcm9sbGNhbGwvSEIxMDAxLjAzLkNPTVMuMjQ5LnBkZi5odG1s",
                "type": "AMENDMENT"
            },
            {
                "target": "HB1001.02.COMH",
                "chamber": {
                    "link": "/2014/chambers/house",
                    "name": "House"
                },
                "rollcall_number": "121",
                "results": null,
                "link": "/2014/rollcalls/MTE4LzIwMTQvY2FiaW5ldC9iaWxscy9ob3VzZS9IQjEwMDEvcm9sbGNhbGwvSEIxMDAxLjAyLkNPTUguMTIxLnBkZi5odG1s",
                "type": "BILL"
            },
            {
                "target": "HB1001.02.COMH.AMH006",
                "chamber": {
                    "link": "/2014/chambers/house",
                    "name": "House"
                },
                "rollcall_number": "114",
                "results": null,
                "link": "/2014/rollcalls/MTE4LzIwMTQvY2FiaW5ldC9iaWxscy9ob3VzZS9IQjEwMDEvcm9sbGNhbGwvSEIxMDAxLjAyLkNPTUguMTE0LnBkZi5odG1s",
                "type": "AMENDMENT"
            }
        ],
        "revno": 1244584
    }