Canparl Get Vote
canparl_get_voteRead a recorded House division, its full official tally, party totals, and a page of individual ballots. Ballot, personId, party, and province filters affect the ballot page only; nonvoters are absent. Omitted session means the verified current official session. Follow nextOffset with identical filters.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum returned ballots, 1–400 per call, default 30; larger values up to 10000 clamp to 400 with a notice. A page ends early at the 24000-byte response budget; follow nextOffset. | |
| party | No | Canonical official caucus or certain Bloc/Green alias; historical observed caucuses are accepted. | |
| ballot | No | Recorded ballot Yea, Nay, or Paired, case-insensitive; Yes and No are accepted as Yea and Nay. | |
| number | Yes | Division number returned by canparl_search_votes or canparl_get_bill. | |
| offset | No | Zero-based offset in the selected ordering. | |
| session | No | Parliamentary session; omitted means current. | |
| personId | No | Decimal official person ID from canparl_search_members detailLookup or a ballot row; matches this division's recorded participants, including members no longer seated. | |
| province | No | English province/territory name or one of the 13 postal codes. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | Effective ballot page limit after the per-call cap. | |
| error | No | Present when the call failed. Absent on success. | |
| shown | No | Returned ballot count. | |
| tally | No | Official counts independent of local filters. | |
| notice | No | Limit clamp, nonvoter, mismatch, empty, past-end, or response-budget guidance. | |
| ballots | No | Matching ballots ordered by caucus, surname, given name, then personId. | |
| byParty | No | Complete unfiltered participant aggregation by source caucus. | |
| division | No | Verified full-session division metadata. | |
| truncated | No | Whether more matching ballots remain, including after a response-budget stop. | |
| pagination | No | Continuation within matching ballots; nextOffset is offset plus ballots returned. | |
| provenance | No | Retrieval metadata for every source request. | |
| totalCount | No | Matching ballot count before pagination. | |
| ballotsTotal | No | Complete recorded participant count. | |
| appliedFilters | No | Normalized ballot filters and division identity. | |
| ballotsMatched | No | Exact matching count before pagination. | |
| tallyMatchesBallots | No | Whether all three official counts match participants; null if any count is absent. |