Module entities/entity.parliament-period

Parliament period related methods

Abgeordnetenwatch API Documentation

Index

Type aliases

Variables

url

Functions

Type aliases

ParliamentPeriodListResult

ParliamentPeriodListResult: { data: EntityParliamentPeriod[]; meta: ResponseMeta }

List result

Type declaration

data: EntityParliamentPeriod[]
meta: ResponseMeta

ParliamentPeriodRelatedDataParameter

ParliamentPeriodRelatedDataParameter: "show_information" | "polls" | "mandates" | "committees" | "constituencies"

Possible extra data that you can include on the response for a single item

ParliamentPeriodResult

ParliamentPeriodResult: { data: EntityParliamentPeriod; meta: ResponseEntityMeta }

Single item result

Type declaration

data: EntityParliamentPeriod
meta: ResponseEntityMeta

Variables

Const url

url: "https://www.abgeordnetenwatch.de/api/v2/parliament-periods" = 'https://www.abgeordnetenwatch.de/api/v2/parliament-periods'

Service Endpoint

Abgeordnetenwatch API documentation

Functions

Const parliamentPeriod

parliamentPeriod(id: number, relatedData?: null | "show_information" | "polls" | "mandates" | "committees" | "constituencies"): Promise<ParliamentPeriodResult>

- Defined in src/entities/entity.parliament-period.ts:76
Get a single ParliamentPeriod
```
response = await parliamentPeriod(5);
```
Parameters
- id: number
  
  Id of the ParliamentPeriod.
- relatedData: null | "show_information" | "polls" | "mandates" | "committees" | "constituencies" = null
  
  Possible related Data you can include in the result
Returns Promise<ParliamentPeriodResult>

ParliamentPeriodResult as JSON

Const parliamentPeriodList

parliamentPeriodList(params?: null | PagerParameters | RangeParameters, sort?: null | SortParameters, filter?: FilterParameters | OperatorFilterParameters[]): Promise<ParliamentPeriodResult>

- Defined in src/entities/entity.parliament-period.ts:58
Get a list of ParliamentPeriod
```
response = await parliamentPeriodList();
```
Parameters
- Optional params: null | PagerParameters | RangeParameters
  
  PagerParameters for Paging, RangeParameters for limiting the results or null
- Optional sort: null | SortParameters
  
  Sort simply by a property or more complex by a list of properties
- Optional filter: FilterParameters | OperatorFilterParameters[]
Returns Promise<ParliamentPeriodResult>

ParliamentPeriodListResult as JSON

Generated using TypeDoc