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

NAME

WebService::UK::Parliament::ErskineMay - Query the UK Parliament Erskine Ma API

VERSION

Version 1.00

SYNOPSIS

use WebService::UK::Parliament::ErskineMay;

my $client = WebService::UK::Parliament::ErskineMay->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 Erskine May data.

Sections

Chapter

getChapter

Returns a single chapter overview by chapter number.

Method

get

Path

/api/Chapter/{chapterNumber}

Parameters

chapterNumber

Chapter overview with the chapter number specified

integer

format: int32

IndexTerm

getIndexTermbrowse

Returns a list of index terms by start letter.

Method

get

Path

/api/IndexTerm/browse

Parameters

startLetter

Index terms by start letter

string

skip

The number of records to skip from the first, default is 0.

integer

format: int32

take

The number of records to return, default is 20, maximum is 20.

integer

format: int32

getIndexTerm

Returns an index term by id.

Method

get

Path

/api/IndexTerm/{indexTermId}

Parameters

indexTermId

Index term by if

integer

format: int32

Part

getPart1

Returns a list of all parts.

Method

get

Path

/api/Part

getPart

Returns a part by part number.

Method

get

Path

/api/Part/{partNumber}

Parameters

partNumber

Part by part number

integer

format: int32

getSearchIndexTermSearchResults

Returns a list of index terms which contain the search term.

Method

get

Path

/api/Search/IndexTermSearchResults/{searchTerm}

Parameters

searchTerm

Index terms which contain search term.

string

skip

The number of records to skip from the first, default is 0.

integer

format: int32

take

The number of records to return, default is 20, maximum is 20.

integer

format: int32

getSearchParagraph

Returns a section overview by reference.

Method

get

Path

/api/Search/Paragraph/{reference}

Parameters

reference

Section overview by reference.

string

getSearchParagraphSearchResults

Returns a list of paragraphs which contain the search term.

Method

get

Path

/api/Search/ParagraphSearchResults/{searchTerm}

Parameters

searchTerm

Paragraphs which contain search term in their content.

string

skip

The number of records to skip from the first, default is 0.

integer

format: int32

take

The number of records to return, default is 20, maximum is 20.

integer

format: int32

getSearchSectionSearchResults

Returns a list of sections which contain the search term.

Method

get

Path

/api/Search/SectionSearchResults/{searchTerm}

Parameters

searchTerm

Sections which contain search term in their title.

string

skip

The number of records to skip from the first, default is 0.

integer

format: int32

take

The number of records to return, default is 20, maximum is 20.

integer

format: int32

Section

getSection

Returns a section by section id.

Method

get

Path

/api/Section/{sectionId}

Parameters

sectionId

Section by id.

integer

format: int32

getSection,

Returns a section overview by section id and step.

Method

get

Path

/api/Section/{sectionId},{step}

Parameters

sectionId

Section by id.

integer

format: int32

step

Number of sections to step over from given section.

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)