/ 
WebService-UK-Parliament-1.00
River stage zero No dependents
/ WebService::UK::Parliament::CommonsVotes

NAME

WebService::UK::Parliament::CommonsVotes - Query the UK Parliament Commons Vo API

VERSION

Version 1.00

SYNOPSIS

use WebService::UK::Parliament::CommonsVotes;

my $client = WebService::UK::Parliament::CommonsVotes->new();

my $data = $client->$endpoint($params);

DESCRIPTION

The following documentation is automatically generated using the UK Parliament OpenAPI specification.

An API that allows querying of Commons Votes data.

Sections

Divisions

getdatadivision.

Return a Division

Method

get

Path

/data/division/{divisionId}.{format}

Parameters

divisionId

Id number of a Division whose records are to be returned

integer

format: int32

format

xml or json

string

getdatadivisions.groupedbyparty

Return Divisions results grouped by party

Method

get

Path

/data/divisions.{format}/groupedbyparty

Parameters

format

xml or json

string

queryParameters.searchTerm

Divisions containing search term within title or number

string

queryParameters.memberId

Divisions returning Member with Member ID voting records

integer

format: int32

queryParameters.includeWhenMemberWasTeller

Divisions where member was a teller as well as if they actually voted

boolean

queryParameters.startDate

Divisions where division date in one or after date provided. Date format is yyyy-MM-dd

string

format: date-time

queryParameters.endDate

Divisions where division date in one or before date provided. Date format is yyyy-MM-dd

string

format: date-time

queryParameters.divisionNumber

Division Number - as specified by the House, unique within a session. This is different to the division id which uniquely identifies a division in this system and is passed to the GET division endpoint

integer

format: int32

getdatadivisions.membervoting

Return voting records for a Member

Method

get

Path

/data/divisions.{format}/membervoting

Parameters

format

xml or json

string

queryParameters.memberId

Id number of a Member whose voting records are to be returned

integer

format: int32

queryParameters.skip

The number of records to skip. Default is 0

integer

format: int32

queryParameters.take

The number of records to return per page. Default is 25

integer

format: int32

queryParameters.searchTerm

Divisions containing search term within title or number

string

queryParameters.includeWhenMemberWasTeller

Divisions where member was a teller as well as if they actually voted

boolean

queryParameters.startDate

Divisions where division date in one or after date provided. Date format is yyyy-MM-dd

string

format: date-time

queryParameters.endDate

Divisions where division date in one or before date provided. Date format is yyyy-MM-dd

string

format: date-time

queryParameters.divisionNumber

Division Number - as specified by the House, unique within a session. This is different to the division id which uniquely identifies a division in this system and is passed to the GET division endpoint

integer

format: int32

getdatadivisions.search

Return a list of Divisions

Method

get

Path

/data/divisions.{format}/search

Parameters

format

json or xml

string

queryParameters.skip

The number of records to skip. Default is 0

integer

format: int32

queryParameters.take

The number of records to return per page. Default is 25

integer

format: int32

queryParameters.searchTerm

Divisions containing search term within title or number

string

queryParameters.memberId

Divisions returning Member with Member ID voting records

integer

format: int32

queryParameters.includeWhenMemberWasTeller

Divisions where member was a teller as well as if they actually voted

boolean

queryParameters.startDate

Divisions where division date in one or after date provided. Date format is yyyy-MM-dd

string

format: date-time

queryParameters.endDate

Divisions where division date in one or before date provided. Date format is yyyy-MM-dd

string

format: date-time

queryParameters.divisionNumber

Division Number - as specified by the House, unique within a session. This is different to the division id which uniquely identifies a division in this system and is passed to the GET division endpoint

integer

format: int32

getdatadivisions.searchTotalResults

Return total results count

Method

get

Path

/data/divisions.{format}/searchTotalResults

Parameters

format

json or xml

string

queryParameters.searchTerm

Divisions containing search term within title or number

string

queryParameters.memberId

Divisions returning Member with Member ID voting records

integer

format: int32

queryParameters.includeWhenMemberWasTeller

Divisions where member was a teller as well as if they actually voted

boolean

queryParameters.startDate

Divisions where division date in one or after date provided. Date format is yyyy-MM-dd

string

format: date-time

queryParameters.endDate

Divisions where division date in one or before date provided. Date format is yyyy-MM-dd

string

format: date-time

queryParameters.divisionNumber

Division Number - as specified by the House, unique within a session. This is different to the division id which uniquely identifies a division in this system and is passed to the GET division endpoint

integer

format: int32

AUTHOR

LNATION, <thisusedtobeanemail at gmail.com>

BUGS

Please report any bugs or feature requests to bug-webservice-uk-parliament at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebService-UK-Parliament. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc WebService::UK::Parliament

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

The first ticehurst bathroom experience

This software is Copyright (c) 2022 by LNATION.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)