v1

latestOpenAPI 3.0.02026-07-14323187.1 KB
Search

Get all results that contain the given search term

Get contributions, written statements, written answers, corrections, petitions, committees, divisions and members that contain the given search term. <br /><br /> There are a maximum of four search results of each type. <br /><br /> The search term can be simple text or it can contain directives for advanced searches.<br /> you can also connect multiple search directives with AND<br /> use spokenby:name to get results when named person spoke<br /> use debate:debate to get results for debates matching supplied text<br /> use words:words to get results containing specified words<br />

get/search.{format}

Path parameters

formatstring required

The required output format (xml or json)

Query parameters

queryParameters.housestring

the parliamentary house (Commons or Lords)

queryParameters.startDatestring date-time

the date to search from (yyyy-mm-dd)

queryParameters.endDatestring date-time

the date to search to (yyyy-mm-dd)

queryParameters.datestring

the date to search (yyyy-mm-dd)

queryParameters.memberIdinteger

the unique id of a member (member details are returned from ‘Search Members’ operation)

queryParameters.divisionIdinteger

the unique id of the division to be searched

queryParameters.hansardIdentifierstring

Hansard identifier

queryParameters.searchTermstring

the term for which to search

queryParameters.skipinteger

how many results to skip (Default is 0)

queryParameters.takeinteger

how many results to return per page

queryParameters.memberIdsstring

the list of member ids in which to search

queryParameters.departmentstring

department to be searched

queryParameters.debateTypestring

debate type to be searched

queryParameters.includeFormerboolean

whether or not to include former members

queryParameters.includeCurrentboolean

whether or not to include current members

queryParameters.withDivisionboolean

whether or not to only include results with a division

queryParameters.seriesNumberinteger

the series number in which to search

queryParameters.volumeNumberinteger

the Volume Number in which to search

queryParameters.columnNumberstring

the Column number for which to search

queryParameters.committeeTitlestring

the title of the committee to be searched

queryParameters.committeeTypeinteger

committee type to be searched

queryParameters.includeCommitteeDivisionsboolean

whether or not to include committee divisions

queryParameters.sectioninteger

unique id of the section to search

queryParameters.outputTypestring

output type (List or Group)

queryParameters.debateSectionIdinteger

the unique id of the debate section to search

queryParameters.timelineGroupingSize'Day' | 'Month' | 'Year'

timeline grouping size. Enter Day, Month or Year

queryParameters.orderBy'SittingDateAsc' | 'SittingDateDesc'

order results (SittingDateAsc or SittingDateDesc)

Response

OK

TotalMembersinteger
TotalContributionsinteger
TotalWrittenStatementsinteger
TotalWrittenAnswersinteger
TotalCorrectionsinteger
TotalPetitionsinteger
TotalDebatesinteger
TotalCommitteesinteger
TotalDivisionsinteger
SearchTermsstring[]