The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
WebService-UK-Parliament-0.04
River stage zero No dependents
1 ++
/ WebService::UK::Parliament::LordsVotes

NAME

WebService::UK::Parliament::LordsVotes - Query the UK Parliament Lords Vo API

VERSION

Version 0.04

SYNOPSIS

        use WebService::UK::Parliament::LordsVotes;

        my $client = WebService::UK::Parliament::LordsVotes->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 Lords Votes data.

Sections

Divisions

getdataDivisionsgroupedbyparty

Return Divisions results grouped by party

Method

get

Path

/data/Divisions/groupedbyparty

Parameters

SearchTerm

Divisions containing search term within title or number

string

MemberId

Divisions returning Member with Member ID voting records

integer

format: int32

IncludeWhenMemberWasTeller

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

boolean

StartDate

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

string

format: date-time

EndDate

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

string

format: date-time

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

TotalVotesCast.Comparator

comparison operator to use

string

LessThan LessThanOrEqualTo EqualTo GreaterThanOrEqualTo GreaterThan

TotalVotesCast.ValueToCompare

value to compare to with the operator provided

integer

format: int32

Majority.Comparator

comparison operator to use

string

LessThan LessThanOrEqualTo EqualTo GreaterThanOrEqualTo GreaterThan

Majority.ValueToCompare

value to compare to with the operator provided

integer

format: int32

getdataDivisionsmembervoting

Return voting records for a Member

Method

get

Path

/data/Divisions/membervoting

Parameters

MemberId

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

integer

format: int32

SearchTerm

Divisions containing search term within title or number

string

IncludeWhenMemberWasTeller

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

boolean

StartDate

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

string

format: date-time

EndDate

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

string

format: date-time

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

TotalVotesCast.Comparator

comparison operator to use

string

LessThan LessThanOrEqualTo EqualTo GreaterThanOrEqualTo GreaterThan

TotalVotesCast.ValueToCompare

value to compare to with the operator provided

integer

format: int32

Majority.Comparator

comparison operator to use

string

LessThan LessThanOrEqualTo EqualTo GreaterThanOrEqualTo GreaterThan

Majority.ValueToCompare

value to compare to with the operator provided

integer

format: int32

skip

The number of records to skip. Must be a positive integer. Default is 0

integer

format: int32

take

The number of records to return per page. Must be more than 0. Default is 25

integer

format: int32

getdataDivisionssearch

Return a list of Divisions

Method

get

Path

/data/Divisions/search

Parameters

SearchTerm

Divisions containing search term within title or number

string

MemberId

Divisions returning Member with Member ID voting records

integer

format: int32

IncludeWhenMemberWasTeller

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

boolean

StartDate

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

string

format: date-time

EndDate

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

string

format: date-time

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

TotalVotesCast.Comparator

comparison operator to use

string

LessThan LessThanOrEqualTo EqualTo GreaterThanOrEqualTo GreaterThan

TotalVotesCast.ValueToCompare

value to compare to with the operator provided

integer

format: int32

Majority.Comparator

comparison operator to use

string

LessThan LessThanOrEqualTo EqualTo GreaterThanOrEqualTo GreaterThan

Majority.ValueToCompare

value to compare to with the operator provided

integer

format: int32

skip

The number of records to skip. Must be a positive integer. Default is 0

integer

format: int32

take

The number of records to return per page. Must be more than 0. Default is 25

integer

format: int32

getdataDivisionssearchTotalResults

Return total results count

Method

get

Path

/data/Divisions/searchTotalResults

Parameters

SearchTerm

Divisions containing search term within title or number

string

MemberId

Divisions returning Member with Member ID voting records

integer

format: int32

IncludeWhenMemberWasTeller

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

boolean

StartDate

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

string

format: date-time

EndDate

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

string

format: date-time

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

TotalVotesCast.Comparator

comparison operator to use

string

LessThan LessThanOrEqualTo EqualTo GreaterThanOrEqualTo GreaterThan

TotalVotesCast.ValueToCompare

value to compare to with the operator provided

integer

format: int32

Majority.Comparator

comparison operator to use

string

LessThan LessThanOrEqualTo EqualTo GreaterThanOrEqualTo GreaterThan

Majority.ValueToCompare

value to compare to with the operator provided

integer

format: int32

getdataDivisions

Return a Division

Method

get

Path

/data/Divisions/{divisionId}

Parameters

divisionId

Division with ID specified

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)