1. Lookup Packets

The first step is to retrieve the list of packets and identify the “id”(s) of the packets on which you wish to report. This endpoint will return the list of packets available including the “id” value.

2. Lookup the Committee Form

The second step is to retrieve “id” of the committee form for which you wish to retrieve form responses. To do so, use the following endpoint to retrieve the list of forms that are reportable, and parse the response body. Each object will have an “id” value and a “form_type” value.

3. Retrieve Form Responses

The values to committee form responses may be retrieved from RPT via following API call:

{
  "form_id": 12345,
  "form_type": "committee_form",
  "packet_ids": [
    54321,
    54322
  ]
}

API Response

A successful response from this end point should result in an HTTP 200 and an accompanying JSON body. An abbreviated example follows.

{
    "column_names": [
        "First Column Name",
        "Second Column Name",
        ...
        "Last Column Name
    ],
    "form_name": "Name of the Form",
    "form_unit_name": "Name of the unit which the form belongs to",
    "limit": 100,
    "page": 1,
    "total_count": 1,
    "results": [
        {
            "packet_id": "12345",
            "table_cells": [
                "value_for_column_1",
                "value_for_column_2",
                ...
                "value_for_last_column"
            ]
        }
    ],
    "subcolumn_names": [
        [],
        [],
        ...
        []
    ]
}

The response begins with an array of the column_names in order. These columns represent the questions on the form. The results array that appears after contains one element for each instance of a form response. Each element includes the packet_id to which it is associated and array of table_cells. This array represents the responses to each of the questions in the same order they're presented in the column_names array.