Skip to content

Commit

Permalink
Merge branch '3.6' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
@kzalewski
kzalewski committed May 12, 2020
2 parents ac0f82d + 1a6adba commit b0190fb
Show file tree
Hide file tree
Showing 144 changed files with 40,072 additions and 1,964 deletions.
79 changes: 42 additions & 37 deletions docs/api/bills.rst
View file
Expand Up @@ -23,7 +23,8 @@ Retrieve bill by session year and print no
+----------------+----------------------------------------------------------------------------------------------+
| version | If view=only_fulltext, use the version to specify the amendment letter, e.g. version=A |
+----------------+----------------------------------------------------------------------------------------------+
| fullTextFormat | (PLAIN or HTML) Which bill text formats will be included. Multiple formats can be requested. |
| fullTextFormat | (PLAIN, HTML, TEMPLATE) Which bill text formats will be included. |
| | Multiple formats can be requested. |
+----------------+----------------------------------------------------------------------------------------------+

View options
Expand Down Expand Up @@ -129,6 +130,7 @@ Default Bill Response
"": { // Map of Amendment versions
"basePrintNo": "S2180", // Bill print no/session details duplicated here
"session": 2013,
"basePrintNoStr": "S2180-2013",
"printNo": "S2180",
"version": "", // Amendment version
"publishDate": "2013-01-14", // Date this amendment was published
Expand All @@ -145,7 +147,10 @@ Default Bill Response
"lawSection": "Penal Law", // The primary section of law this bill impacts.
"lawCode": "Add §265.18, Pen L", // A code that states the actions being taken on specific portions of law.
"actClause": "AN ACT to amend the..", // An Act to Clause
"fullTextFormats": [ "PLAIN" ],
"fullText": "...", // Full text of the bill amendment
"fullTextHtml": null,
"fullTextTemplate": null,
"coSponsors": { // List of co sponsors
"items": [
{
Expand Down Expand Up @@ -342,23 +347,23 @@ List bills within a session year
**Optional Params**
+----------------+--------------------+--------------------------------------------------------+
| Parameter | Values | Description |
+================+====================+========================================================+
| limit | 1 - 1000 | Number of results to return |
+----------------+--------------------+--------------------------------------------------------+
| offset | >= 1 | Result number to start from |
+----------------+--------------------+--------------------------------------------------------+
| full | boolean | Set to true to see the full bill responses. |
+----------------+--------------------+--------------------------------------------------------+
| idsOnly | boolean | Set to true to see only the printNo and session |
| | | for each bill. (overrides 'full' parameter) |
+----------------+--------------------+--------------------------------------------------------+
| sort | string | Sort by any field from the response. |
+----------------+--------------------+--------------------------------------------------------+
| fullTextFormat | (PLAIN or HTML) | Which bill text formats will be included. |
| | | Multiple formats can be requested. |
+----------------+--------------------+--------------------------------------------------------+
+----------------+------------------------------+--------------------------------------------------------+
| Parameter | Values | Description |
+================+==============================+========================================================+
| limit | 1 - 1000 | Number of results to return |
+----------------+------------------------------+--------------------------------------------------------+
| offset | >= 1 | Result number to start from |
+----------------+------------------------------+--------------------------------------------------------+
| full | boolean | Set to true to see the full bill responses. |
+----------------+------------------------------+--------------------------------------------------------+
| idsOnly | boolean | Set to true to see only the printNo and session |
| | | for each bill. (overrides 'full' parameter) |
+----------------+------------------------------+--------------------------------------------------------+
| sort | string | Sort by any field from the response. |
+----------------+------------------------------+--------------------------------------------------------+
| fullTextFormat | (PLAIN, HTML or TEMPLATE) | Which bill text formats will be included. |
| | | Multiple formats can be requested. |
+----------------+------------------------------+--------------------------------------------------------+
**Default Sort Order**
Expand Down Expand Up @@ -491,25 +496,25 @@ List of bills updated since the given date/time
**Optional Params**
+----------------+----------------------+--------------------------------------------------------+
| Parameter | Values | Description |
+================+======================+========================================================+
| type | (processed|published)| The type of bill update (see below for explanation) |
+----------------+----------------------+--------------------------------------------------------+
| detail | boolean | Set to true to see `detailed update digests`_ |
+----------------+----------------------+--------------------------------------------------------+
| filter | string | Filter by update type. See `update filters`_ |
+----------------+----------------------+--------------------------------------------------------+
| order | string (asc|desc) | Order the results by update date/time |
+----------------+----------------------+--------------------------------------------------------+
| summary | boolean | Include a bill info response per item |
+----------------+----------------------+--------------------------------------------------------+
| fullBill | boolean | Include a bill info response per item |
+----------------+----------------------+--------------------------------------------------------+
| fullTextFormat | (PLAIN or HTML) | Which bill text formats will be included |
| | | if full bills are requested. |
| | | Multiple formats can be requested. |
+----------------+----------------------+--------------------------------------------------------+
+----------------+---------------------------+--------------------------------------------------------+
| Parameter | Values | Description |
+================+===========================+========================================================+
| type | (processed|published) | The type of bill update (see below for explanation) |
+----------------+---------------------------+--------------------------------------------------------+
| detail | boolean | Set to true to see `detailed update digests`_ |
+----------------+---------------------------+--------------------------------------------------------+
| filter | string | Filter by update type. See `update filters`_ |
+----------------+---------------------------+--------------------------------------------------------+
| order | string (asc|desc) | Order the results by update date/time |
+----------------+---------------------------+--------------------------------------------------------+
| summary | boolean | Include a bill info response per item |
+----------------+---------------------------+--------------------------------------------------------+
| fullBill | boolean | Include a bill info response per item |
+----------------+---------------------------+--------------------------------------------------------+
| fullTextFormat | (PLAIN, HTML or TEMPLATE) | Which bill text formats will be included |
| | | if full bills are requested. |
| | | Multiple formats can be requested. |
+----------------+---------------------------+--------------------------------------------------------+
.. warning:: By default the type is set to 'processed'. Ensure you have the right type in the api request so you receive the results you are looking for
Expand Down
48 changes: 36 additions & 12 deletions docs/api/members.rst
View file
Expand Up @@ -29,18 +29,39 @@ Get member with id 371 during 2013 session year.

.. code-block:: javascript
{
"success" : true,
"message" : "",
"responseType" : "member",
"result" : {
"memberId" : 371, // The member id.
"shortName" : "SEWARD", // The members short name, uniquely identifies each member during a session.
"sessionYear" : 2013, // The session year.
"chamber" : "SENATE", // The chamber
"fullName" : "James L. Seward", // Members full name.
"districtCode" : 51 // Members district.
}
"success" : true,
"message" : "",
"responseType" : "member-sessions",
"result" : {
"memberId" : 371,
"chamber" : "SENATE",
"incumbent" : true,
"fullName" : "James L. Seward",
"shortName" : "SEWARD",
"sessionShortNameMap" : {
"2013" : [ {
"sessionMemberId" : 127,
"shortName" : "SEWARD",
"sessionYear" : 2013,
"districtCode" : 51,
"alternate" : false,
"memberId" : 371
} ]
},
"person" : {
"personId" : 190,
"fullName" : "James L. Seward",
"firstName" : "James",
"middleName" : "L.",
"lastName" : "Seward",
"email" : "seward@senate.state.ny.us",
"prefix" : "Senator",
"suffix" : null,
"verified" : true,
"imgName" : "371_james_l._seward.jpg"
}
}
}
Get a list of members
Expand Down Expand Up @@ -95,6 +116,9 @@ Search within a session year
::
(GET) /api/3/members/{sessionYear}/search?term=YOUR_TERM

Note: given a sessionMemberId = #### in a session year yyyy, you can get the member that sessionMemberId is used by with:
::
(GET) /api/3/members/search?term=sessionShortNameMap.yyyy.sessionMemberId=####

**Required Params**

Expand Down Expand Up @@ -122,4 +146,4 @@ Search within a session year

List all members who have served district code 20
::
/api/3/members/search?term=districtCode:20
/api/3/members/search?term=districtCode:20
31 changes: 15 additions & 16 deletions docs/api/transcripts_floor.rst
View file
Expand Up @@ -8,15 +8,15 @@ Get a single Transcript

**Usage**

Retrieve transcript by filename
Retrieve transcript by dateTime
::
(GET) /api/3/transcripts/{filename}
(GET) /api/3/transcripts/{dateTime}

**Examples**

Request transcript 090314.txt
Request transcript 2014-09-03T09:00
::
/api/3/transcripts/090314.txt
/api/3/transcripts/2014-09-03T09:00

**Response**

Expand All @@ -25,15 +25,14 @@ Full Transcript Response
.. code-block:: javascript
{
"success" : true, // Indicates if a transcript was found.
"message" : "Data for transcript 090314.txt", // Response description.
"responseType" : "transcript", // Response data type.
"success" : true, // Indicates if a transcript was found.
"message" : "Data for transcript 2014-09-03T09:00:00", // Response description.
"responseType" : "transcript", // Response data type.
"result" : {
"filename" : "090314.txt", // Filename of transcript.
"sessionType" : "REGULAR SESSION", // Session type
"dateTime" : "2014-09-03T09:00", // Date Time of senate session.
"location" : "ALBANY, NEW YORK", // Location of senate session.
"text" : "5100\n\n 1 NEW YORK STATE SE.." // The text of the transcript.
"dateTime" : "2014-09-03T09:00", // The date and time of the session.
"sessionType" : "REGULAR SESSION", // Session type
"location" : "ALBANY, NEW YORK", // Location of senate session.
"text" : "5100\n\n 1 NEW YORK STATE SE.." // The text of the transcript.
}
}
Expand All @@ -42,15 +41,15 @@ Get a transcript pdf

**Usage**

Retrieve transcript pdf by filename
Retrieve transcript pdf by dateTime
::
(GET) /api/3/transcripts/{filename}.pdf
(GET) /api/3/transcripts/{dateTime}.pdf

**Examples**

Request transcript 090314.txt
Request transcript 2014-09-03T09:00
::
/api/3/transcripts/090314.txt.pdf
/api/3/transcripts/2014-09-03T09:00

Get a list of transcripts
-------------------------
Expand Down

0 comments on commit b0190fb

Please sign in to comment.